Changeset 57574

Timestamp:

02/09/2024 10:38:38 AM (3 years ago)

Author:

gziolo

Message:

Editor: Refactor block binding processing and attribute computation

Refactors the processing of block bindings into steps:

• Gets the value for each "bound" attribute from the respective source.
• Returns the computer attributes with values from the sources.
• The computed attributes get injected into block's content.
• The render_callback gets the updated list of attributes and processeded block content.

Fixes #60282.
Props czapla, gziolo, andraganescu, santosguillamot.

Location:

trunk

Files:

• src/wp-includes/class-wp-block.php (modified) (9 diffs)
• tests/phpunit/tests/block-bindings/render.php (modified) (2 diffs)

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

@@ -193 +193 @@
 
         /**
-         * Processes the block bindings in block's attributes.
+         * Processes the block bindings and updates the block attributes with the values from the sources.
          *
          * A block might contain bindings in its attributes. Bindings are mappings
@@ -200 +200 @@
          * retrieve a value from outside the block, e.g. from post meta.
          *
-         * This function will process those bindings and replace the HTML with the value of the binding.
-         * The value is retrieved from the source of the binding.
+         * This function will process those bindings and update the block's attributes
+         * with the values coming from the bindings.
          *
          * ### Example
@@ -229 +229 @@
          * @since 6.5.0
          *
-         * @param string $block_content Block content.
-         * @param array  $block         The full block, including name and attributes.
-         * @return string The modified block content.
-         */
-        private function process_block_bindings( $block_content ) {
+         * @return array The computed block attributes for the provided block bindings.
+         */
+        private function process_block_bindings() {
                 $parsed_block = $this->parsed_block;
+
+                $computed_attributes = array();
 
                 // Allowed blocks that support block bindings.
@@ -252 +252 @@
                         ! is_array( $parsed_block['attrs']['metadata']['bindings'] )
                 ) {
-                        return $block_content;
-                }
-
-                $modified_block_content = $block_content;
+                        return $computed_attributes;
+                }
+
                 foreach ( $parsed_block['attrs']['metadata']['bindings'] as $attribute_name => $block_binding ) {
                         // If the attribute is not in the allowed list, process next attribute.
@@ -276 +275 @@
                         // If the value is not null, process the HTML based on the block and the attribute.
                         if ( ! is_null( $source_value ) ) {
-                                $modified_block_content = $this->replace_html( $modified_block_content, $attribute_name, $source_value );
-                        }
-                }
-
-                return $modified_block_content;
+                                $computed_attributes[ $attribute_name ] = $source_value;
+                        }
+                }
+
+                return $computed_attributes;
         }
 
@@ -392 +391 @@
          *
          * @since 5.5.0
+         * @since 6.5.0 Added block bindings processing.
          *
          * @global WP_Post $post Global post object.
@@ -411 +411 @@
                 );
 
+                // Process the block bindings and get attributes updated with the values from the sources.
+                $computed_attributes = $this->process_block_bindings();
+                if ( ! empty( $computed_attributes ) ) {
+                        // Merge the computed attributes with the original attributes
+                        $this->attributes = array_merge( $this->attributes, $computed_attributes );
+                }
+
                 $is_dynamic    = $options['dynamic'] && $this->name && null !== $this->block_type && $this->block_type->is_dynamic();
                 $block_content = '';
@@ -446 +453 @@
                 }
 
+                if ( ! empty( $computed_attributes ) && ! empty( $block_content ) ) {
+                        foreach ( $computed_attributes as $attribute_name => $source_value ) {
+                                $block_content = $this->replace_html( $block_content, $attribute_name, $source_value );
+                        }
+                }
+
                 if ( $is_dynamic ) {
                         $global_post = $post;
@@ -488 +501 @@
                         }
                 }
-
-                // Process the block bindings for this block, if any are registered. This
-                // will replace the block content with the value from a registered binding source.
-                $block_content = $this->process_block_bindings( $block_content );
 
                 /**

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

@@ -53 +53 @@
 
                 $block_content = <<<HTML
-<!-- wp:paragraph {"metadata":{"bindings":{"content":{"source":"test/source"}}}} --><p>This should not appear</p><!-- /wp:paragraph -->
+<!-- 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();
 
-                $expected = '<p>test source value</p>';
-                $result   = $block->render();
-
-                $this->assertEquals( $expected, $result, 'The block content should be updated with the value returned by the source.' );
+                $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>',
+                        trim( $result ),
+                        'The block content should be updated with the value returned by the source.'
+                );
         }
 
@@ -86 +94 @@
                 );
 
-                $value         = 'test';
                 $block_content = <<<HTML
-<!-- wp:paragraph {"metadata":{"bindings":{"content":{"source":"test/source", "args": {"key": "$value"}}}}} --><p>This should not appear</p><!-- /wp:paragraph -->
+<!-- wp:paragraph {"metadata":{"bindings":{"content":{"source":"test/source", "args": {"key": "test"}}}}} -->
+<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();
 
-                $expected = "<p>The attribute name is 'content' and its binding has argument 'key' with value '$value'.</p>";
-                $result   = $block->render();
+                $this->assertSame(
+                        "The attribute name is 'content' and its binding has argument 'key' with value 'test'.",
+                        $block->attributes['content'],
+                        "The 'content' attribute should be updated with the value returned by the source."
+                );
+                $this->assertSame(
+                        "<p>The attribute name is 'content' and its binding has argument 'key' with value 'test'.</p>",
+                        trim( $result ),
+                        'The block content should be updated with the value returned by the source.'
+                );
+        }
 
-                $this->assertEquals( $expected, $result, 'The block content should be updated with the value returned by the source.' );
+        /**
+         * Tests if the block content is updated with the value returned by the source
+         * for the Image block in the placeholder state.
+         *
+         * @ticket 60282
+         *
+         * @covers ::register_block_bindings_source
+         */
+        public function test_update_block_with_value_from_source_image_placeholder() {
+                $get_value_callback = function () {
+                        return 'https://example.com/image.jpg';
+                };
+
+                register_block_bindings_source(
+                        self::SOURCE_NAME,
+                        array(
+                                'label'              => self::SOURCE_LABEL,
+                                'get_value_callback' => $get_value_callback,
+                        )
+                );
+
+                $block_content = <<<HTML
+<!-- wp:image {"metadata":{"bindings":{"url":{"source":"test/source"}}}} -->
+<figure class="wp-block-image"><img alt=""/></figure>
+<!-- /wp:image -->
+HTML;
+                $parsed_blocks = parse_blocks( $block_content );
+                $block         = new WP_Block( $parsed_blocks[0] );
+                $result        = $block->render();
+
+                $this->assertSame(
+                        'https://example.com/image.jpg',
+                        $block->attributes['url'],
+                        "The 'url' attribute should be updated with the value returned by the source."
+                );
+                $this->assertSame(
+                        '<figure class="wp-block-image"><img src="https://example.com/image.jpg" alt=""/></figure>',
+                        trim( $result ),
+                        'The block content should be updated with the value returned by the source.'
+                );
         }
 }