WP_HTML_Processor::insert_foreign_element( WP_HTML_Token $token, bool $only_add_to_element_stack )
- Since
- 6.7.0
- Source
wp-includes/html-api/class-wp-html-processor.php:6256
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
$tokenWP_HTML_Token- Insert this token. The token's namespace and insertion point will be updated correctly.
$only_add_to_element_stackbool- Whether to skip the "insert an element at the adjusted insertion location" algorithm when adding this element.
Performance profile
How much work a call to WP_HTML_Processor::insert_foreign_element() 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
- 19–22
- Plugin surface
- None
- Called by
- 1
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 26.
Nothing here hands control to plugin code.
1 place 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_foreign_element() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
->is_mathml_integration_point() | 19–20 | ->get_adjusted_current_node(), ->is_mathml_integration_point(), ->insert_html_element() |
!->is_mathml_integration_point() | 19–22 | ->get_adjusted_current_node(), ->is_mathml_integration_point(), ->is_html_integration_point(), ->insert_html_element() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 26 | 19–22 | 3 | |
| 8.5 | 26 | 19–22 | 3 | |
| 8.4 | 26 | 19–22 | 3 | |
| 8.3 | 26 | 19–22 | 3 | |
| 8.2 | 26 | 19–22 | 3 | |
| 8.1 | 26 | 19–22 | 3 | 1 fewer instruction than PHP 7.4 |
| 7.4 | 27 | 19–23 | 3 |
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::get_adjusted_current_node()Returns the adjusted current node.
- WP_HTML_Processor::is_mathml_integration_point()Indicates if the current token is a MathML integration point.
- WP_HTML_Processor::is_html_integration_point()Indicates if the current token is an HTML integration point.
- WP_HTML_Processor::insert_html_element()Inserts an HTML element on the stack of open elements.
Used by · 1
- WP_HTML_Processor::step_in_foreign_content()Parses next element in the 'in foreign content' insertion mode.
Source code
private function insert_foreign_element( WP_HTML_Token $token, bool $only_add_to_element_stack ): void { $adjusted_current_node = $this->get_adjusted_current_node(); $token->namespace = $adjusted_current_node ? $adjusted_current_node->namespace : 'html'; if ( $this->is_mathml_integration_point() ) { $token->integration_node_type = 'math'; } elseif ( $this->is_html_integration_point() ) { $token->integration_node_type = 'html'; } if ( false === $only_add_to_element_stack ) { /* * @todo Implement the "appropriate place for inserting a node" and the * "insert an element at the adjusted insertion location" algorithms. * * These algorithms mostly impacts DOM tree construction and not the HTML API. * Here, there's no DOM node onto which the element will be appended, so the * parser will skip this step. * * @see https://html.spec.whatwg.org/#insert-an-element-at-the-adjusted-insertion-location */ } $this->insert_html_element( $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.