WP_Block::replace_html( string $block_content, string $attribute_name, mixed $source_value ): string

Compatibility

Present in every tracked release (6.7.10 to 7.1.3), 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.

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

9–126

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

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 · 13 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.

Uses · 2

• wp_kses_post()Sanitizes content for allowed HTML tags for post content.
• WP_HTML_Tag_Processor::__construct()Constructor.

Used by · 1

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

Source code

View on Trac ↗View on GitHub ↗

382	private function replace_html( string $block_content, string $attribute_name, $source_value ) {383		$block_type = $this->block_type;384		if ( ! isset( $block_type->attributes[ $attribute_name ]['source'] ) ) {385			return $block_content;386		}387 388		// Depending on the attribute source, the processing will be different.389		switch ( $block_type->attributes[ $attribute_name ]['source'] ) {390			case 'html':391			case 'rich-text':392				$block_reader = new WP_HTML_Tag_Processor( $block_content );393 394				// TODO: Support for CSS selectors whenever they are ready in the HTML API.395				// In the meantime, support comma-separated selectors by exploding them into an array.396				$selectors = explode( ',', $block_type->attributes[ $attribute_name ]['selector'] );397				// Add a bookmark to the first tag to be able to iterate over the selectors.398				$block_reader->next_tag();399				$block_reader->set_bookmark( 'iterate-selectors' );400 401				// TODO: This shouldn't be needed when the `set_inner_html` function is ready.402				// Store the parent tag and its attributes to be able to restore them later in the button.403				// The button block has a wrapper while the paragraph and heading blocks don't.404				if ( 'core/button' === $this->name ) {405					$button_wrapper                 = $block_reader->get_tag();406					$button_wrapper_attribute_names = $block_reader->get_attribute_names_with_prefix( '' );407					$button_wrapper_attrs           = array();408					foreach ( $button_wrapper_attribute_names as $name ) {409						$button_wrapper_attrs[ $name ] = $block_reader->get_attribute( $name );410					}411				}412 413				foreach ( $selectors as $selector ) {414					// If the parent tag, or any of its children, matches the selector, replace the HTML.415					if ( strcasecmp( $block_reader->get_tag(), $selector ) === 0 || $block_reader->next_tag(416						array(417							'tag_name' => $selector,418						)419					) ) {420						$block_reader->release_bookmark( 'iterate-selectors' );421 422						// TODO: Use `set_inner_html` method whenever it's ready in the HTML API.423						// Until then, it is hardcoded for the paragraph, heading, and button blocks.424						// Store the tag and its attributes to be able to restore them later.425						$selector_attribute_names = $block_reader->get_attribute_names_with_prefix( '' );426						$selector_attrs           = array();427						foreach ( $selector_attribute_names as $name ) {428							$selector_attrs[ $name ] = $block_reader->get_attribute( $name );429						}430						$selector_markup = "<$selector>" . wp_kses_post( $source_value ) . "</$selector>";431						$amended_content = new WP_HTML_Tag_Processor( $selector_markup );432						$amended_content->next_tag();433						foreach ( $selector_attrs as $attribute_key => $attribute_value ) {434							$amended_content->set_attribute( $attribute_key, $attribute_value );435						}436						if ( 'core/paragraph' === $this->name || 'core/heading' === $this->name ) {437							return $amended_content->get_updated_html();438						}439						if ( 'core/button' === $this->name ) {440							$button_markup  = "<$button_wrapper>{$amended_content->get_updated_html()}</$button_wrapper>";441							$amended_button = new WP_HTML_Tag_Processor( $button_markup );442							$amended_button->next_tag();443							foreach ( $button_wrapper_attrs as $attribute_key => $attribute_value ) {444								$amended_button->set_attribute( $attribute_key, $attribute_value );445							}446							return $amended_button->get_updated_html();447						}448					} else {449						$block_reader->seek( 'iterate-selectors' );450					}451				}452				$block_reader->release_bookmark( 'iterate-selectors' );453				return $block_content;454 455			case 'attribute':456				$amended_content = new WP_HTML_Tag_Processor( $block_content );457				if ( ! $amended_content->next_tag(458					array(459						// TODO: build the query from CSS selector.460						'tag_name' => $block_type->attributes[ $attribute_name ]['selector'],461					)

Changelog

Introduced in 6.5.0. One change between 6.7.10 and 7.1.3.

1. 6.7.10
2. 6.8.11
3. 6.9.10
4. 7.0.7
5. 7.1.3

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

About this page

Parsed data

Generated from the wordpress-develop 6.8.11 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.