WP_HTML_Token::__construct( string|null $bookmark_name, string $node_name, bool $has_self_closing_flag, callable|null $on_destroy = null )

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$bookmark_namestring|null

Name of bookmark corresponding to location in HTML where token is found, or null for markers and nodes without a bookmark.

$node_namestring

Name of node token represents; if uppercase, an HTML element; if lowercase, a special value like "marker".

$has_self_closing_flagbool

Whether the source token contains the self-closing flag, regardless of whether it's valid.

$on_destroycallable|nulloptional

Function to call when destroying token, useful for releasing the bookmark.Default: null

Performance profile

How much work a call to WP_HTML_Token::__construct() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

15

Executed per call on PHP 8.5. The body compiles to 15.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

5

5 places in core call this, so the cost is paid more often than your own code shows.

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_HTML_Token::__construct() can have, taken from its control-flow graph on PHP 8.5.

Used by · 5

• WP_HTML_Active_Formatting_Elements::insert_marker()Inserts a "marker" at the end of the list of active formatting elements.
• WP_HTML_Processor::create_fragment_at_current_node()Creates a fragment processor at the current node.
• WP_HTML_Processor::insert_virtual_node()Inserts a virtual element on the stack of open elements.
• WP_HTML_Processor::seek()Moves the internal cursor in the HTML Processor to a given bookmark's location.
• WP_HTML_Processor::step()Steps through the HTML document and stop at the next tag, if any.

Source code

View on Trac ↗View on GitHub ↗

99	public function __construct( ?string $bookmark_name, string $node_name, bool $has_self_closing_flag, ?callable $on_destroy = null ) {100		$this->bookmark_name         = $bookmark_name;101		$this->namespace             = 'html';102		$this->node_name             = $node_name;103		$this->has_self_closing_flag = $has_self_closing_flag;104		$this->on_destroy            = $on_destroy;105	}

Changelog

Introduced in 6.4.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/html-api/class-wp-html-token.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.