WP_HTML_Processor::step_in_foreign_content(): bool

Description

Compatibility

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_foreign_content() 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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with how much data it finds.

Instructions

18–107

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

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

What one call costs · 24 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_foreign_content() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 27

• 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::get_attribute()Returns the value of a requested attribute from a matched tag opener if that attribute exists.
• WP_HTML_Processor::insert_foreign_element()Inserts a foreign element on to 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_initial()Parses next element in the 'initial' insertion mode.
• WP_HTML_Processor::step_before_html()Parses next element in the 'before html' insertion mode.
• WP_HTML_Processor::step_before_head()Parses next element in the 'before head' insertion mode.
• WP_HTML_Processor::step_in_head()Parses next element in the 'in head' insertion mode.
• WP_HTML_Processor::step_in_head_noscript()Parses next element in the 'in head noscript' insertion mode.
• WP_HTML_Processor::step_after_head()Parses next element in the 'after head' insertion mode.

Used by · 1

• WP_HTML_Processor::step()Steps through the HTML document and stop at the next tag, if any.

Source code

View on Trac ↗View on GitHub ↗

4806	private function step_in_foreign_content(): bool {4807		$tag_name   = $this->get_token_name();4808		$token_type = $this->get_token_type();4809		$op_sigil   = '#tag' === $token_type ? ( $this->is_tag_closer() ? '-' : '+' ) : '';4810		$op         = "{$op_sigil}{$tag_name}";4811 4812		/*4813		 * > A start tag whose name is "font", if the token has any attributes named "color", "face", or "size"4814		 *4815		 * This section drawn out above the switch to more easily incorporate4816		 * the additional rules based on the presence of the attributes.4817		 */4818		if (4819			'+FONT' === $op &&4820			(4821				null !== $this->get_attribute( 'color' ) ||4822				null !== $this->get_attribute( 'face' ) ||4823				null !== $this->get_attribute( 'size' )4824			)4825		) {4826			$op = '+FONT with attributes';4827		}4828 4829		switch ( $op ) {4830			case '#text':4831				/*4832				 * > A character token that is U+0000 NULL4833				 *4834				 * This is handled by `get_modifiable_text()`.4835				 */4836 4837				/*4838				 * Whitespace-only text does not affect the frameset-ok flag.4839				 * It is probably inter-element whitespace, but it may also4840				 * contain character references which decode only to whitespace.4841				 */4842				if ( parent::TEXT_IS_GENERIC === $this->text_node_classification ) {4843					$this->state->frameset_ok = false;4844				}4845 4846				$this->insert_foreign_element( $this->state->current_token, false );4847				return true;4848 4849			/*4850			 * CDATA sections are alternate wrappers for text content and therefore4851			 * ought to follow the same rules as text nodes.4852			 */4853			case '#cdata-section':4854				/*4855				 * NULL bytes and whitespace do not change the frameset-ok flag.4856				 */4857				$current_token        = $this->bookmarks[ $this->state->current_token->bookmark_name ];4858				$cdata_content_start  = $current_token->start + 9;4859				$cdata_content_length = $current_token->length - 12;4860				if ( strspn( $this->html, "\0 \t\n\f\r", $cdata_content_start, $cdata_content_length ) !== $cdata_content_length ) {4861					$this->state->frameset_ok = false;4862				}4863 4864				$this->insert_foreign_element( $this->state->current_token, false );4865				return true;4866 4867			/*4868			 * > A comment token4869			 * > A processing instruction token4870			 */4871			case '#comment':4872			case '#funky-comment':4873			case '#presumptuous-tag':4874			case '#processing-instruction':4875				$this->insert_foreign_element( $this->state->current_token, false );4876				return true;4877 4878			/*4879			 * > A DOCTYPE token4880			 */4881			case 'html':4882				// Parse error: ignore the token.4883				return $this->step();4884 4885			/*

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.