WP_HTML_Processor::step_in_head(): bool
- Since
- 6.7.0
- Source
wp-includes/html-api/class-wp-html-processor.php:1843
Parses next element in the 'in head' insertion mode.
Description
This internal function performs the 'in head' insertion mode logic for the generalized WP_HTML_Processor::step() function.
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.
Return value
bool- Whether an element was found.
Performance profile
How much work a call to WP_HTML_Processor::step_in_head() 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–94
- Plugin surface
- None
- Called by
- 11
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 262.
Nothing here hands control to plugin code.
11 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 14 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_HTML_Processor::step_in_head() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 19–71 | ->get_token_name(), ->get_token_type(), ::is_tag_closer(), ->step() |
| always | 19–37 | ->get_token_name(), ->get_token_type(), ::is_tag_closer(), ->step_in_body() |
| always | 22–62 | ->get_token_name(), ->get_token_type(), ::is_tag_closer(), ->insert_html_element() |
| always | 24–64 | ->get_token_name(), ->get_token_type(), ::is_tag_closer(), ->pop() |
!->contains() | 25–73 | ->get_token_name(), ->get_token_type(), ::is_tag_closer(), ->contains(), ->step() |
| always | 30–81 | ->get_token_name(), ->get_token_type(), ::is_tag_closer(), ->pop(), ->step() |
| always | 38–84 | ->get_token_name(), ->get_token_type(), ::is_tag_closer(), ->insert_marker(), ->insert_html_element() |
!is_string($charset) | 42–72 | ->get_token_name(), ->get_token_type(), ::is_tag_closer(), ->insert_html_element(), ->get_attribute(), ->get_attribute(), ->get_attribute() |
is_string($charset) | 45–75 | ->get_token_name(), ->get_token_type(), ::is_tag_closer(), ->insert_html_element(), ->get_attribute(), ->bail(), ->get_attribute(), ->get_attribute() |
->contains() | 46–94 | ->get_token_name(), ->get_token_type(), ::is_tag_closer(), ->contains(), ->generate_implied_end_tags_thoroughly(), ->current_node_is(), ->pop_until(), ->clear_up_to_last_marker(), array_pop(), ->reset_insertion_mode_appropriately() |
!is_string($charset) && is_string($http_equiv) && is_string($content) | 50–78 | ->get_token_name(), ->get_token_type(), ::is_tag_closer(), ->insert_html_element(), ->get_attribute(), ->get_attribute(), ->get_attribute(), strcasecmp() |
!is_string($charset) && is_string($http_equiv) && is_string($content) | 53–81 | ->get_token_name(), ->get_token_type(), ::is_tag_closer(), ->insert_html_element(), ->get_attribute(), ->get_attribute(), ->get_attribute(), strcasecmp(), ->bail() |
2 further outcomes, up to 84 instructions
is_string($charset) && is_string($http_equiv) && is_string($content) | 53–81 | ->get_token_name(), ->get_token_type(), ::is_tag_closer(), ->insert_html_element(), ->get_attribute(), ->bail(), ->get_attribute(), ->get_attribute(), strcasecmp() |
is_string($charset) && is_string($http_equiv) && is_string($content) | 56–84 | ->get_token_name(), ->get_token_type(), ::is_tag_closer(), ->insert_html_element(), ->get_attribute(), ->bail(), ->get_attribute(), ->get_attribute(), strcasecmp(), ->bail() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 262 | 19–94 | 34 | |
| 8.5 | 262 | 19–94 | 34 | |
| 8.4 | 262 | 19–94 | 34 | |
| 8.3 | 262 | 19–94 | 34 | |
| 8.2 | 262 | 19–94 | 34 | 1 more instruction than PHP 8.1 |
| 8.1 | 261 | 19–94 | 34 | 1 more instruction than PHP 7.4 |
| 7.4 | 260 | 19–93 | 34 |
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 · 10
- WP_HTML_Processor::get_token_name()Returns the node name represented by the token.
- WP_HTML_Processor::get_token_type()Indicates the kind of matched token, if any.
- WP_HTML_Tag_Processor::is_tag_closer()Indicates if the current tag token is a tag closer.
- WP_HTML_Processor::insert_html_element()Inserts an HTML element on the stack of open elements.
- WP_HTML_Processor::step()Steps through the HTML document and stop at the next tag, if any.
- WP_HTML_Processor::step_in_body()Parses next element in the 'in body' insertion mode.
- WP_HTML_Processor::get_attribute()Returns the value of a requested attribute from a matched tag opener if that attribute exists.
- WP_HTML_Processor::bail()Stops the parser and terminates its execution when encountering unsupported markup.
- WP_HTML_Processor::generate_implied_end_tags_thoroughly()Closes elements that have implied end tags, thoroughly.
- WP_HTML_Processor::reset_insertion_mode_appropriately()Runs the reset the insertion mode appropriately algorithm.
Used by · 11
- WP_HTML_Processor::step()Steps through the HTML document and stop at the next tag, if any.
- WP_HTML_Processor::step_after_after_frameset()Parses next element in the 'after after frameset' insertion mode.
- WP_HTML_Processor::step_after_frameset()Parses next element in the 'after frameset' insertion mode.
- WP_HTML_Processor::step_after_head()Parses next element in the 'after head' insertion mode.
- WP_HTML_Processor::step_in_body()Parses next element in the 'in body' insertion mode.
- WP_HTML_Processor::step_in_column_group()Parses next element in the 'in column group' insertion mode.
- WP_HTML_Processor::step_in_foreign_content()Parses next element in the 'in foreign content' insertion mode.
- WP_HTML_Processor::step_in_frameset()Parses next element in the 'in frameset' insertion mode.
- WP_HTML_Processor::step_in_head_noscript()Parses next element in the 'in head noscript' insertion mode.
- WP_HTML_Processor::step_in_table()Parses next element in the 'in table' insertion mode.
- WP_HTML_Processor::step_in_template()Parses next element in the 'in template' insertion mode.
Source code
private function step_in_head(): bool { $token_name = $this->get_token_name(); $token_type = $this->get_token_type(); $is_closer = parent::is_tag_closer(); $op_sigil = '#tag' === $token_type ? ( $is_closer ? '-' : '+' ) : ''; $op = "{$op_sigil}{$token_name}"; switch ( $op ) { case '#text': /* * > A character token that is one of U+0009 CHARACTER TABULATION, * > U+000A LINE FEED (LF), U+000C FORM FEED (FF), * > U+000D CARRIAGE RETURN (CR), or U+0020 SPACE */ if ( parent::TEXT_IS_WHITESPACE === $this->text_node_classification ) { // Insert the character. $this->insert_html_element( $this->state->current_token ); return true; } goto in_head_anything_else; break; /* * > A comment token * > A processing instruction token */ case '#comment': case '#funky-comment': case '#presumptuous-tag': case '#processing-instruction': $this->insert_html_element( $this->state->current_token ); return true; /* * > A DOCTYPE token */ case 'html': // Parse error: ignore the token. return $this->step(); /* * > A start tag whose tag name is "html" */ case '+HTML': return $this->step_in_body(); /* * > A start tag whose tag name is one of: "base", "basefont", "bgsound", "link" */ case '+BASE': case '+BASEFONT': case '+BGSOUND': case '+LINK': $this->insert_html_element( $this->state->current_token ); return true; /* * > A start tag whose tag name is "meta" */ case '+META': $this->insert_html_element( $this->state->current_token ); // All following conditions depend on "tentative" encoding confidence. if ( 'tentative' !== $this->state->encoding_confidence ) { return true; } /* * > If the active speculative HTML parser is null, then: * > - If the element has a charset attribute, and getting an encoding from * > its value results in an encoding, and the confidence is currently * > tentative, then change the encoding to the resulting encoding. */ $charset = $this->get_attribute( 'charset' ); if ( is_string( $charset ) ) { $this->bail( 'Cannot yet process META tags with charset to determine encoding.' ); } /*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.