wppaste
WordPress

WP_HTML_Processor::reconstruct_active_formatting_elements(): bool

Since
6.4.0
Source
wp-includes/html-api/class-wp-html-processor.php:5907
Reconstructs the active formatting elements.

Description

This has the effect of reopening all the formatting elements that were opened in the current body, cell, or caption (whichever is youngest) that haven't been explicitly closed.

Compatibility

WordPress
since 6.4.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 any formatting elements needed to be reconstructed.

Performance profile

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

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

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

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

WhenInstructionsCalls it makes
always7->count()
always15->count(), ->current_node()
->contains_node()21->count(), ->current_node(), ->contains_node()
!->contains_node()25->count(), ->current_node(), ->contains_node(), ->bail()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 27 instructions, 7–25 executed per call, 3 branches. The work does not change between versions.

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 · 1

Used by · 1

Source code

	private function reconstruct_active_formatting_elements(): bool {		/*		 * > If there are no entries in the list of active formatting elements, then there is nothing		 * > to reconstruct; stop this algorithm.		 */		if ( 0 === $this->state->active_formatting_elements->count() ) {			return false;		} 		$last_entry = $this->state->active_formatting_elements->current_node();		if ( 			/*			 * > If the last (most recently added) entry in the list of active formatting elements is a marker;			 * > stop this algorithm.			 */			'marker' === $last_entry->node_name || 			/*			 * > If the last (most recently added) entry in the list of active formatting elements is an			 * > element that is in the stack of open elements, then there is nothing to reconstruct;			 * > stop this algorithm.			 */			$this->state->stack_of_open_elements->contains_node( $last_entry )		) {			return false;		} 		$this->bail( 'Cannot reconstruct active formatting elements when advancing and rewinding is required.' );	}

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.