Changeset 60684

Timestamp:

08/27/2025 03:41:36 PM (12 months ago)

Author:

Bernhard Reiter

Message:

Block Bindings: Allow generically setting rich-text block attributes.

Replace the existing block-specific, hard-coded, logic in the WP_Block class with more generic code that is able to locate and replace a rich-text sourced attribute based on the selector definition in its block.json.

This should make it easier to add block bindings support for more block attributes.

Props bernhard-reiter, jonsurrell, gziolo, cbravobernal, dmsnell.
Fixes #63840.

Location:

trunk

Files:

• src/wp-includes/class-wp-block.php (modified) (4 diffs)
• tests/phpunit/tests/block-bindings/render.php (modified) (3 diffs)
• tests/phpunit/tests/block-bindings/wp-block-get-block-bindings-processor.php (added)

trunk/src/wp-includes/class-wp-block.php

@@ -417 +417 @@
                         case 'html':
                         case 'rich-text':
-                                $block_reader = new WP_HTML_Tag_Processor( $block_content );
+                                $block_reader = self::get_block_bindings_processor( $block_content );
 
                                 // TODO: Support for CSS selectors whenever they are ready in the HTML API.
@@ -425 +425 @@
                                 $block_reader->next_tag();
                                 $block_reader->set_bookmark( 'iterate-selectors' );
-
-                                // TODO: This shouldn't be needed when the `set_inner_html` function is ready.
-                                // Store the parent tag and its attributes to be able to restore them later in the button.
-                                // The button block has a wrapper while the paragraph and heading blocks don't.
-                                if ( 'core/button' === $this->name ) {
-                                        $button_wrapper                 = $block_reader->get_tag();
-                                        $button_wrapper_attribute_names = $block_reader->get_attribute_names_with_prefix( '' );
-                                        $button_wrapper_attrs           = array();
-                                        foreach ( $button_wrapper_attribute_names as $name ) {
-                                                $button_wrapper_attrs[ $name ] = $block_reader->get_attribute( $name );
-                                        }
-                                }
 
                                 foreach ( $selectors as $selector ) {
@@ -445 +433 @@
                                                 )
                                         ) ) {
+                                                // TODO: Use `WP_HTML_Processor::set_inner_html` method once it's available.
                                                 $block_reader->release_bookmark( 'iterate-selectors' );
-
-                                                // TODO: Use `set_inner_html` method whenever it's ready in the HTML API.
-                                                // Until then, it is hardcoded for the paragraph, heading, and button blocks.
-                                                // Store the tag and its attributes to be able to restore them later.
-                                                $selector_attribute_names = $block_reader->get_attribute_names_with_prefix( '' );
-                                                $selector_attrs           = array();
-                                                foreach ( $selector_attribute_names as $name ) {
-                                                        $selector_attrs[ $name ] = $block_reader->get_attribute( $name );
-                                                }
-                                                $selector_markup = "<$selector>" . wp_kses_post( $source_value ) . "</$selector>";
-                                                $amended_content = new WP_HTML_Tag_Processor( $selector_markup );
-                                                $amended_content->next_tag();
-                                                foreach ( $selector_attrs as $attribute_key => $attribute_value ) {
-                                                        $amended_content->set_attribute( $attribute_key, $attribute_value );
-                                                }
-                                                if ( 'core/paragraph' === $this->name || 'core/heading' === $this->name ) {
-                                                        return $amended_content->get_updated_html();
-                                                }
-                                                if ( 'core/button' === $this->name ) {
-                                                        $button_markup  = "<$button_wrapper>{$amended_content->get_updated_html()}</$button_wrapper>";
-                                                        $amended_button = new WP_HTML_Tag_Processor( $button_markup );
-                                                        $amended_button->next_tag();
-                                                        foreach ( $button_wrapper_attrs as $attribute_key => $attribute_value ) {
-                                                                $amended_button->set_attribute( $attribute_key, $attribute_value );
-                                                        }
-                                                        return $amended_button->get_updated_html();
-                                                }
+                                                $block_reader->replace_rich_text( wp_kses_post( $source_value ) );
+                                                return $block_reader->get_updated_html();
                                         } else {
                                                 $block_reader->seek( 'iterate-selectors' );
@@ -498 +462 @@
         }
 
+        private static function get_block_bindings_processor( string $block_content ) {
+                $internal_processor_class = new class('', WP_HTML_Processor::CONSTRUCTOR_UNLOCK_CODE) extends WP_HTML_Processor {
+                        /**
+                         * Replace the rich text content between a tag opener and matching closer.
+                         *
+                         * When stopped on a tag opener, replace the content enclosed by it and its
+                         * matching closer with the provided rich text.
+                         *
+                         * @param string $rich_text The rich text to replace the original content with.
+                         * @return bool True on success.
+                         */
+                        public function replace_rich_text( $rich_text ) {
+                                if ( $this->is_tag_closer() || ! $this->expects_closer() ) {
+                                        return false;
+                                }
+
+                                $depth = $this->get_current_depth();
+
+                                $this->set_bookmark( '_wp_block_bindings_tag_opener' );
+                                // The bookmark names are prefixed with `_` so the key below has an extra `_`.
+                                $tag_opener = $this->bookmarks['__wp_block_bindings_tag_opener'];
+                                $start      = $tag_opener->start + $tag_opener->length;
+                                $this->release_bookmark( '_wp_block_bindings_tag_opener' );
+
+                                // Find matching tag closer.
+                                while ( $this->next_token() && $this->get_current_depth() >= $depth ) {
+                                }
+
+                                $this->set_bookmark( '_wp_block_bindings_tag_closer' );
+                                $tag_closer  = $this->bookmarks['__wp_block_bindings_tag_closer'];
+                                $end         = $tag_closer->start;
+                                $this->release_bookmark( '_wp_block_bindings_tag_closer' );
+
+                                $this->lexical_updates[] = new WP_HTML_Text_Replacement(
+                                        $start,
+                                        $end - $start,
+                                        $rich_text
+                                );
+
+                                return true;
+                        }
+                };
+
+                return $internal_processor_class::create_fragment( $block_content );
+        }
 
         /**

trunk/tests/phpunit/tests/block-bindings/render.php

@@ -62 +62 @@
         }
 
+        public function data_update_block_with_value_from_source() {
+                return array(
+                        'paragraph block' => array(
+                                'content',
+                                <<<HTML
+<!-- wp:paragraph -->
+<p>This should not appear</p>
+<!-- /wp:paragraph -->
+HTML
+                                ,
+                                '<p>test source value</p>',
+                        ),
+                        'button block'    => array(
+                                'text',
+                                <<<HTML
+<!-- wp:button -->
+<div class="wp-block-button"><a class="wp-block-button__link wp-element-button">This should not appear</a></div>
+<!-- /wp:button -->
+HTML
+                                ,
+                                '<div class="wp-block-button"><a class="wp-block-button__link wp-element-button">test source value</a></div>',
+                        ),
+                );
+        }
+
         /**
          * Test if the block content is updated with the value returned by the source.
@@ -68 +93 @@
          *
          * @covers ::register_block_bindings_source
-         */
-        public function test_update_block_with_value_from_source() {
+         *
+         * @dataProvider data_update_block_with_value_from_source
+         */
+        public function test_update_block_with_value_from_source( $bound_attribute, $block_content, $expected_result ) {
                 $get_value_callback = function () {
                         return 'test source value';
@@ -82 +109 @@
                 );
 
-                $block_content = <<<HTML
-<!-- wp:paragraph {"metadata":{"bindings":{"content":{"source":"test/source"}}}} -->
-<p>This should not appear</p>
-<!-- /wp:paragraph -->
-HTML;
-                $parsed_blocks = parse_blocks( $block_content );
-                $block         = new WP_Block( $parsed_blocks[0] );
-                $result        = $block->render();
+                $parsed_blocks = parse_blocks( $block_content );
+
+                $parsed_blocks[0]['attrs']['metadata'] = array(
+                        'bindings' => array(
+                                $bound_attribute => array(
+                                        'source' => self::SOURCE_NAME,
+                                ),
+                        ),
+                );
+
+                $block  = new WP_Block( $parsed_blocks[0] );
+                $result = $block->render();
 
                 $this->assertSame(
                         'test source value',
-                        $block->attributes['content'],
-                        "The 'content' attribute should be updated with the value returned by the source."
-                );
-                $this->assertSame(
-                        '<p>test source value</p>',
+                        $block->attributes[ $bound_attribute ],
+                        "The '{$bound_attribute}' attribute should be updated with the value returned by the source."
+                );
+                $this->assertSame(
+                        $expected_result,
                         trim( $result ),
                         'The block content should be updated with the value returned by the source.'