wppaste
WordPress

WP_HTML_Processor::step_after_frameset(): bool

Since
6.7.0
Source
wp-includes/html-api/class-wp-html-processor.php:4581
Parses next element in the 'after frameset' insertion mode.

Description

This internal function performs the 'after 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_after_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

Touches nothing outside its own arguments.

Scaling
Constant

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

Instructions
16–42

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 82.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
2

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

What one call costs · 10 distinct outcomes

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

WhenInstructionsCalls it makes
$token_type !== "#tag"16–30->get_token_name(), ->get_token_type(), ->step_in_body()
$token_type !== "#tag"16–36->get_token_name(), ->get_token_type(), ->step()
$token_type !== "#tag"16–34->get_token_name(), ->get_token_type(), ->step_in_head()
$token_type !== "#tag"19–29->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–42->get_token_name(), ->get_token_type(), ->is_tag_closer(), ->step()
$token_type === "#tag"21–40->get_token_name(), ->get_token_type(), ->is_tag_closer(), ->step_in_head()
$token_type !== "#tag"24–26->get_token_name(), ->get_token_type(), ->bail(), ->step()
$token_type === "#tag"24–35->get_token_name(), ->get_token_type(), ->is_tag_closer(), ->insert_html_element()
$token_type === "#tag"29–32->get_token_name(), ->get_token_type(), ->is_tag_closer(), ->bail(), ->step()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev8216–4213
8.58216–4213
8.48216–4213
8.38216–4213
8.28216–42131 more instruction than PHP 8.1
8.18116–4813
7.48116–4813

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

Used by · 2

Source code

View on Trac View on GitHub 

	private function step_after_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 after 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(); 			/*			 * > An end tag whose tag name is "html"			 */			case '-HTML':				$this->state->insertion_mode = WP_HTML_Processor_State::INSERTION_MODE_AFTER_AFTER_FRAMESET;				/*				 * The HTML element is not removed from the stack of open elements.				 * Only internal state has changed, this does not qualify as a "step"				 * in terms of advancing through the document to another token.				 * Nothing has been pushed or popped.				 * Proceed to parse the next item.				 */				return $this->step(); 			/*			 * > A start tag whose tag name is "noframes"			 */			case '+NOFRAMES':				return $this->step_in_head();		} 		// Parse error: ignore the token.		return $this->step();	}

Changelog

Introduced in 6.7.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-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.