WP_Block::replace_html( string $block_content, string $attribute_name, mixed $source_value, int[] $inner_block_offsets = array() ): string

Compatibility

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

Parameters

$block_contentstring

Block content.

$attribute_namestring

The attribute name to replace.

$source_valuemixed

The value used to replace in the HTML.

$inner_block_offsetsint[]optional

Byte offsets where each inner block's rendered output begins. Default empty array.Default: array()

Return value

string

The modified block content.

Performance profile

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

10–64

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

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

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

Used by · 1

• WP_Block::render()Generates the render output for the block.

Source code

View on Trac ↗View on GitHub ↗

376	private function replace_html( string $block_content, string $attribute_name, $source_value, array $inner_block_offsets = array() ) {377		$block_type = $this->block_type;378		if ( ! isset( $block_type->attributes[ $attribute_name ]['source'] ) ) {379			return $block_content;380		}381 382		// Depending on the attribute source, the processing will be different.383		switch ( $block_type->attributes[ $attribute_name ]['source'] ) {384			case 'html':385			case 'rich-text':386				$block_reader = self::get_block_bindings_processor( $block_content );387 388				// TODO: Support for CSS selectors whenever they are ready in the HTML API.389				// In the meantime, support comma-separated selectors by exploding them into an array.390				$selectors = explode( ',', $block_type->attributes[ $attribute_name ]['selector'] );391				// Add a bookmark to the first tag to be able to iterate over the selectors.392				$block_reader->next_tag();393				$block_reader->set_bookmark( 'iterate-selectors' );394 395				foreach ( $selectors as $selector ) {396					// If the parent tag, or any of its children, matches the selector, replace the HTML.397					if ( strcasecmp( $block_reader->get_tag(), $selector ) === 0 || $block_reader->next_tag(398						array(399							'tag_name' => $selector,400						)401					) ) {402						/*403						 * TODO: Use `WP_HTML_Processor::set_inner_html()` once it's available.404						 * Any replacement must preserve already-rendered inner block405						 * markup verbatim (it may come from dynamic blocks), so it406						 * cannot re-serialize the element's contents. Until an API with407						 * that guarantee exists, the replacement is spliced by byte408						 * offset, leaving inner block output untouched.409						 */410						$block_reader->release_bookmark( 'iterate-selectors' );411						$block_reader->replace_rich_text( wp_kses_post( $source_value ), $inner_block_offsets );412						return $block_reader->get_updated_html();413					} else {414						$block_reader->seek( 'iterate-selectors' );415					}416				}417				$block_reader->release_bookmark( 'iterate-selectors' );418				return $block_content;419 420			case 'attribute':421				$amended_content = new WP_HTML_Tag_Processor( $block_content );422				if ( ! $amended_content->next_tag(423					array(424						// TODO: build the query from CSS selector.425						'tag_name' => $block_type->attributes[ $attribute_name ]['selector'],426					)427				) ) {428					return $block_content;429				}430				$amended_content->set_attribute( $block_type->attributes[ $attribute_name ]['attribute'], $source_value );431				return $amended_content->get_updated_html();432 433			default:434				return $block_content;435		}436	}

Changelog

Introduced in 6.5.0. One change between 6.7.7 and 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/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.