WP_HTML_Processor::run_adoption_agency_algorithm()

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Performance profile

How much work a call to WP_HTML_Processor::run_adoption_agency_algorithm() 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

19–104

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

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 · 21 distinct outcomes

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

Uses · 3

• WP_HTML_Processor::get_tag()Returns the uppercase name of the matched tag.
• WP_HTML_Processor::bail()Stops the parser and terminates its execution when encountering unsupported markup.
• WP_HTML_Processor::is_special()Returns whether an element of a given name is in the HTML special category.

Used by · 1

• WP_HTML_Processor::step_in_body()Parses next element in the 'in body' insertion mode.

Source code

View on Trac ↗View on GitHub ↗

6102	private function run_adoption_agency_algorithm(): void {6103		$budget       = 1000;6104		$subject      = $this->get_tag();6105		$current_node = $this->state->stack_of_open_elements->current_node();6106 6107		if (6108			// > If the current node is an HTML element whose tag name is subject6109			$current_node && $subject === $current_node->node_name &&6110			// > the current node is not in the list of active formatting elements6111			! $this->state->active_formatting_elements->contains_node( $current_node )6112		) {6113			$this->state->stack_of_open_elements->pop();6114			return;6115		}6116 6117		$outer_loop_counter = 0;6118		while ( $budget-- > 0 ) {6119			if ( $outer_loop_counter++ >= 8 ) {6120				return;6121			}6122 6123			/*6124			 * > Let formatting element be the last element in the list of active formatting elements that:6125			 * >   - is between the end of the list and the last marker in the list,6126			 * >     if any, or the start of the list otherwise,6127			 * >   - and has the tag name subject.6128			 */6129			$formatting_element = null;6130			foreach ( $this->state->active_formatting_elements->walk_up() as $item ) {6131				if ( 'marker' === $item->node_name ) {6132					break;6133				}6134 6135				if ( $subject === $item->node_name ) {6136					$formatting_element = $item;6137					break;6138				}6139			}6140 6141			// > If there is no such element, then return and instead act as described in the "any other end tag" entry above.6142			if ( null === $formatting_element ) {6143				$this->bail( 'Cannot run adoption agency when "any other end tag" is required.' );6144			}6145 6146			// > If formatting element is not in the stack of open elements, then this is a parse error; remove the element from the list, and return.6147			if ( ! $this->state->stack_of_open_elements->contains_node( $formatting_element ) ) {6148				$this->state->active_formatting_elements->remove_node( $formatting_element );6149				return;6150			}6151 6152			// > If formatting element is in the stack of open elements, but the element is not in scope, then this is a parse error; return.6153			if ( ! $this->state->stack_of_open_elements->has_element_in_scope( $formatting_element->node_name ) ) {6154				return;6155			}6156 6157			/*6158			 * > Let furthest block be the topmost node in the stack of open elements that is lower in the stack6159			 * > than formatting element, and is an element in the special category. There might not be one.6160			 */6161			$is_above_formatting_element = true;6162			$furthest_block              = null;6163			foreach ( $this->state->stack_of_open_elements->walk_down() as $item ) {6164				if ( $is_above_formatting_element && $formatting_element->bookmark_name !== $item->bookmark_name ) {6165					continue;6166				}6167 6168				if ( $is_above_formatting_element ) {6169					$is_above_formatting_element = false;6170					continue;6171				}6172 6173				if ( self::is_special( $item ) ) {6174					$furthest_block = $item;6175					break;6176				}6177			}6178 6179			/*6180			 * > If there is no furthest block, then the UA must first pop all the nodes from the bottom of the6181			 * > stack of open elements, from the current node up to and including formatting element, then

Changelog

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