WP_HTML_Processor::step_in_frameset(): bool
- Since
- 6.7.0
- Source
wp-includes/html-api/class-wp-html-processor.php:4459
Parses next element in the 'in frameset' insertion mode.
Description
This internal function performs the 'in frameset' 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_frameset() 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
- 16–59
- Plugin surface
- None
- Called by
- 2
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 123.
Nothing here hands control to plugin code.
2 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 18 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_frameset() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
$token_type !== "#tag" | 16–30 | ->get_token_name(), ->get_token_type(), ->step_in_body() |
$token_type !== "#tag" | 16–39 | ->get_token_name(), ->get_token_type(), ->step() |
$token_type !== "#tag" | 16–38 | ->get_token_name(), ->get_token_type(), ->step_in_head() |
$token_type !== "#tag" | 19–35 | ->get_token_name(), ->get_token_type(), ->insert_html_element() |
$token_type === "#tag" | 21–36 | ->get_token_name(), ->get_token_type(), ->is_tag_closer(), ->step_in_body() |
$token_type === "#tag" | 21–45 | ->get_token_name(), ->get_token_type(), ->is_tag_closer(), ->step() |
$token_type === "#tag" | 21–44 | ->get_token_name(), ->get_token_type(), ->is_tag_closer(), ->step_in_head() |
$token_type !== "#tag" && ->current_node_is() | 22–40 | ->get_token_name(), ->get_token_type(), ->current_node_is(), ->step() |
$token_type !== "#tag" | 23–43 | ->get_token_name(), ->get_token_type(), ->insert_html_element(), ->pop() |
$token_type !== "#tag" | 24–26 | ->get_token_name(), ->get_token_type(), ->bail(), ->step() |
$token_type === "#tag" | 24–41 | ->get_token_name(), ->get_token_type(), ->is_tag_closer(), ->insert_html_element() |
$token_type !== "#tag" && !->current_node_is() && isset($value) | 25–43 | ->get_token_name(), ->get_token_type(), ->current_node_is(), ->pop() |
6 further outcomes, up to 59 instructions
$token_type === "#tag" && ->current_node_is() | 27–46 | ->get_token_name(), ->get_token_type(), ->is_tag_closer(), ->current_node_is(), ->step() |
$token_type === "#tag" | 28–49 | ->get_token_name(), ->get_token_type(), ->is_tag_closer(), ->insert_html_element(), ->pop() |
$token_type === "#tag" | 29–32 | ->get_token_name(), ->get_token_type(), ->is_tag_closer(), ->bail(), ->step() |
$token_type === "#tag" && !->current_node_is() && isset($value) | 30–49 | ->get_token_name(), ->get_token_type(), ->is_tag_closer(), ->current_node_is(), ->pop() |
$token_type !== "#tag" && !->current_node_is() && !isset($value) | 31–53 | ->get_token_name(), ->get_token_type(), ->current_node_is(), ->pop(), ->current_node_is() |
$token_type === "#tag" && !->current_node_is() && !isset($value) | 36–59 | ->get_token_name(), ->get_token_type(), ->is_tag_closer(), ->current_node_is(), ->pop(), ->current_node_is() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 123 | 16–59 | 18 | |
| 8.5 | 123 | 16–59 | 18 | |
| 8.4 | 123 | 16–59 | 18 | |
| 8.3 | 123 | 16–59 | 18 | |
| 8.2 | 123 | 16–59 | 18 | 1 more instruction than PHP 8.1 |
| 8.1 | 122 | 16–59 | 18 | |
| 7.4 | 122 | 16–59 | 18 |
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 · 8
- 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_Processor::is_tag_closer()Indicates if the current tag token is a tag closer.
- WP_HTML_Processor::step_in_body()Parses next element in the 'in body' insertion mode.
- WP_HTML_Processor::bail()Stops the parser and terminates its execution when encountering unsupported markup.
- 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_head()Parses next element in the 'in head' insertion mode.
Used by · 2
- WP_HTML_Processor::step()Steps through the HTML document and stop at the next tag, if any.
- WP_HTML_Processor::step_in_foreign_content()Parses next element in the 'in foreign content' insertion mode.
Source code
private function step_in_frameset(): bool { $tag_name = $this->get_token_name(); $token_type = $this->get_token_type(); $op_sigil = '#tag' === $token_type ? ( $this->is_tag_closer() ? '-' : '+' ) : ''; $op = "{$op_sigil}{$tag_name}"; switch ( $op ) { /* * > 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 * > * > Insert the character. * * This algorithm effectively strips non-whitespace characters from text and inserts * them under HTML. This is not supported at this time. */ case '#text': if ( parent::TEXT_IS_WHITESPACE === $this->text_node_classification ) { return $this->step_in_body(); } $this->bail( 'Non-whitespace characters cannot be handled in frameset.' ); 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 "frameset" */ case '+FRAMESET': $this->insert_html_element( $this->state->current_token ); return true; /* * > An end tag whose tag name is "frameset" */ case '-FRAMESET': /* * > If the current node is the root html element, then this is a parse error; * > ignore the token. (fragment case) */ if ( $this->state->stack_of_open_elements->current_node_is( 'HTML' ) ) { return $this->step(); } /* * > Otherwise, pop the current node from the stack of open elements. */ $this->state->stack_of_open_elements->pop(); /* * > If the parser was not created as part of the HTML fragment parsing algorithm * > (fragment case), and the current node is no longer a frameset element, then * > switch the insertion mode to "after frameset". */ if ( ! isset( $this->context_node ) && ! $this->state->stack_of_open_elements->current_node_is( 'FRAMESET' ) ) { $this->state->insertion_mode = WP_HTML_Processor_State::INSERTION_MODE_AFTER_FRAMESET; }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.