class@anonymous::replace_rich_text( string $rich_text, int[] $inner_block_offsets = array() ): bool

Description

Compatibility

Present in 3 of the 5 tracked releases, and compiles on PHP 7.4 through 8.6-dev.

Parameters

$rich_textstring

The rich text to replace the original content with.

$inner_block_offsetsint[]optional

Byte offsets in the source HTML where inner blocks' rendered output begins. Default empty array.Default: array()

Return value

bool

True on success.

Performance profile

How much work a call to class@anonymous::replace_rich_text() 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 what you pass in.

Instructions

6–60

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What one call costs · 8 distinct outcomes

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

Uses · 7

• \\class@anonymous::is_tag_closer()
• \\class@anonymous::expects_closer()
• \\class@anonymous::get_current_depth()
• \\class@anonymous::get_tag()
• \\class@anonymous::set_bookmark()
• \\class@anonymous::next_token()
• WP_HTML_Text_Replacement::__construct()Constructor.

Source code

View on Trac ↗View on GitHub ↗

456			public function replace_rich_text( $rich_text, $inner_block_offsets = array() ) {457				if ( $this->is_tag_closer() || ! $this->expects_closer() ) {458					return false;459				}460 461				$depth    = $this->get_current_depth();462				$tag_name = $this->get_tag();463 464				$this->set_bookmark( '_wp_block_bindings' );465				// The bookmark names are prefixed with `_` so the key below has an extra `_`.466				$tag_opener = $this->bookmarks['__wp_block_bindings'];467				$start      = $tag_opener->start + $tag_opener->length;468 469				// Find matching tag closer.470				while ( $this->next_token() && $this->get_current_depth() >= $depth ) {471				}472 473				if ( ! $this->is_tag_closer() || $tag_name !== $this->get_tag() ) {474					return false;475				}476 477				$this->set_bookmark( '_wp_block_bindings' );478				$tag_closer = $this->bookmarks['__wp_block_bindings'];479				$end        = $tag_closer->start;480 481				/*482				 * Stop at the first inner block that renders inside this element so483				 * its markup is preserved. The block's own rich text always precedes484				 * its inner blocks, so replacing up to the first inner block offset485				 * replaces only that rich text. Offsets are recorded during render in486				 * the same byte coordinates as this fragment, and are in ascending487				 * order, so the first match is the earliest inner block.488				 *489				 * The lower bound is inclusive of `$start`: when an inner block490				 * begins immediately, with no leading rich text, the (empty) rich491				 * text is still replaced instead of the inner block markup.492				 */493				foreach ( $inner_block_offsets as $inner_block_offset ) {494					if ( $inner_block_offset >= $start && $inner_block_offset < $end ) {495						$end = $inner_block_offset;496						break;497					}498				}499 500				$this->lexical_updates[] = new WP_HTML_Text_Replacement(501					$start,502					$end - $start,503					$rich_text504				);505 506				return true;507			}

Changelog

One change between 6.9.7 and 7.1.0.

1. 6.9.7
2. 7.0.4
3. 7.1.0

Signature, return type and hooks compared across 3 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/class-wp-block.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.