WP_Block::replace_html │ private │ WP 6.5.0

Depending on the block attribute name, replace its value in the HTML based on the value provided.

Method of the class: WP_Block{}

No Hooks.

Returns

String. The modified block content.

Usage

// private - for code of main (parent) class only
$result = $this->replace_html( $block_content, $attribute_name, $source_value );

$block_content(string) (required)

Block content.

$attribute_name(string) (required)

The attribute name to replace.

$source_value(mixed) (required)

The value used to replace in the HTML.

Changelog

WP_Block::replace_html() WP Block::replace html code ^{WP 6.9}

private function replace_html( string $block_content, string $attribute_name, $source_value ) {
	$block_type = $this->block_type;
	if ( ! isset( $block_type->attributes[ $attribute_name ]['source'] ) ) {
		return $block_content;
	}

	// Depending on the attribute source, the processing will be different.
	switch ( $block_type->attributes[ $attribute_name ]['source'] ) {
		case 'html':
		case 'rich-text':
			$block_reader = self::get_block_bindings_processor( $block_content );

			// TODO: Support for CSS selectors whenever they are ready in the HTML API.
			// In the meantime, support comma-separated selectors by exploding them into an array.
			$selectors = explode( ',', $block_type->attributes[ $attribute_name ]['selector'] );
			// Add a bookmark to the first tag to be able to iterate over the selectors.
			$block_reader->next_tag();
			$block_reader->set_bookmark( 'iterate-selectors' );

			foreach ( $selectors as $selector ) {
				// If the parent tag, or any of its children, matches the selector, replace the HTML.
				if ( strcasecmp( $block_reader->get_tag(), $selector ) === 0 || $block_reader->next_tag(
					array(
						'tag_name' => $selector,
					)
				) ) {
					// TODO: Use `WP_HTML_Processor::set_inner_html` method once it's available.
					$block_reader->release_bookmark( 'iterate-selectors' );
					$block_reader->replace_rich_text( wp_kses_post( $source_value ) );
					return $block_reader->get_updated_html();
				} else {
					$block_reader->seek( 'iterate-selectors' );
				}
			}
			$block_reader->release_bookmark( 'iterate-selectors' );
			return $block_content;

		case 'attribute':
			$amended_content = new WP_HTML_Tag_Processor( $block_content );
			if ( ! $amended_content->next_tag(
				array(
					// TODO: build the query from CSS selector.
					'tag_name' => $block_type->attributes[ $attribute_name ]['selector'],
				)
			) ) {
				return $block_content;
			}
			$amended_content->set_attribute( $block_type->attributes[ $attribute_name ]['attribute'], $source_value );
			return $amended_content->get_updated_html();

		default:
			return $block_content;
	}
}