WP_HTML_Processor::insert_virtual_node( string $token_name, string|null $bookmark_name = null ): WP_HTML_Token
- Since
- 6.7.0
- Source
wp-includes/html-api/class-wp-html-processor.php:6296
Compatibility
- WordPress
- since 6.7.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$token_namestring- Name of token to create and insert into the stack of open elements.
$bookmark_namestring|nulloptional- Name to give bookmark for created virtual node.
Defaults to auto-creating a bookmark name.Default:null
Return value
WP_HTML_Token- Newly-created virtual token.
Performance profile
How much work a call to WP_HTML_Processor::insert_virtual_node() 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
- Scaling
- Constant
- Instructions
- 29–32
- Plugin surface
- None
- Called by
- 5
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 32.
Nothing here hands control to plugin code.
5 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_HTML_Processor::insert_virtual_node() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 29 | ->insert_html_element() |
| always | 32 | ->bookmark_token(), ->insert_html_element() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 31 | 29–31 | 1 | 1 fewer instruction than PHP 8.5 |
| 8.5 | 32 | 29–32 | 1 | |
| 8.4 | 32 | 29–32 | 1 | |
| 8.3 | 32 | 29–32 | 1 | |
| 8.2 | 32 | 29–32 | 1 | |
| 8.1 | 32 | 29–32 | 1 | |
| 7.4 | 32 | 29–32 | 1 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 4
- WP_HTML_Processor::bookmark_token()Creates a new bookmark for the currently-matched token and returns the generated name.
- WP_HTML_Span::__construct()Constructor.
- WP_HTML_Token::__construct()Constructor - creates a reference to a token in some external HTML string.
- WP_HTML_Processor::insert_html_element()Inserts an HTML element on the stack of open elements.
Used by · 5
- WP_HTML_Processor::step_after_head()Parses next element in the 'after head' insertion mode.
- WP_HTML_Processor::step_before_head()Parses next element in the 'before head' insertion mode.
- WP_HTML_Processor::step_before_html()Parses next element in the 'before html' insertion mode.
- WP_HTML_Processor::step_in_table()Parses next element in the 'in table' insertion mode.
- WP_HTML_Processor::step_in_table_body()Parses next element in the 'in table body' insertion mode.
Source code
private function insert_virtual_node( $token_name, $bookmark_name = null ): WP_HTML_Token { $here = $this->bookmarks[ $this->state->current_token->bookmark_name ]; $name = $bookmark_name ?? $this->bookmark_token(); $this->bookmarks[ $name ] = new WP_HTML_Span( $here->start, 0 ); $token = new WP_HTML_Token( $name, $token_name, false ); $this->insert_html_element( $token ); return $token; }Changelog
Introduced in 6.7.0. Unchanged from 6.7.7 through 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-processor.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.