Changeset 60611

Timestamp:

08/06/2025 06:20:22 PM (5 months ago)

Author:

Bernhard Reiter

Message:

Block Bindings: Add filter to set supported block attributes.

Add a new filter, block_bindings_supported_attributes_{$block_type}, that allows customizing which of a block's attributes can be connected to a Block Bindings source.

Props bernhard-reiter, gziolo, maxschmeling.
Closes #62090.

Location:

trunk

Files:

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

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

@@ -98 +98 @@
      */
     public $inner_content = array();
+
+    /**
+     * List of supported block attributes for block bindings.
+     *
+     * @since 6.9.0
+     * @var array
+     *
+     * @see WP_Block::process_block_bindings()
+     */
+    private const BLOCK_BINDINGS_SUPPORTED_ATTRIBUTES = array(
+        'core/paragraph' => array( 'content' ),
+        'core/heading'   => array( 'content' ),
+        'core/image'     => array( 'id', 'url', 'title', 'alt' ),
+        'core/button'    => array( 'url', 'text', 'linkTarget', 'rel' ),
+        'core/post-date' => array( 'datetime' ),
+    );
 
     /**
@@ -279 +295 @@
      */
     private function process_block_bindings() {
+        $block_type                 = $this->name;
         $parsed_block               = $this->parsed_block;
         $computed_attributes        = array();
-        $supported_block_attributes = array(
-            'core/paragraph' => array( 'content' ),
-            'core/heading'   => array( 'content' ),
-            'core/image'     => array( 'id', 'url', 'title', 'alt' ),
-            'core/button'    => array( 'url', 'text', 'linkTarget', 'rel' ),
-            'core/post-date' => array( 'datetime' ),
+
+        $supported_block_attributes =
+            self::BLOCK_BINDINGS_SUPPORTED_ATTRIBUTES[ $block_type ] ??
+            array();
+
+        /**
+         * Filters the supported block attributes for block bindings.
+         *
+         * The dynamic portion of the hook name, `$block_type`, refers to the block type
+         * whose attributes are being filtered.
+         *
+         * @since 6.9.0
+         *
+         * @param string[] $supported_block_attributes The block's attributes that are supported by block bindings.
+         */
+        $supported_block_attributes = apply_filters(
+            "block_bindings_supported_attributes_{$block_type}",
+            $supported_block_attributes
         );
 
@@ -292 +321 @@
         // block types, or the bindings property is not an array, return the block content.
         if (
-            ! isset( $supported_block_attributes[ $this->name ] ) ||
+            empty( $supported_block_attributes ) ||
             empty( $parsed_block['attrs']['metadata']['bindings'] ) ||
             ! is_array( $parsed_block['attrs']['metadata']['bindings'] )
@@ -316 +345 @@
              * resulting array.
              */
-            foreach ( $supported_block_attributes[ $parsed_block['blockName'] ] as $attribute_name ) {
+            foreach ( $supported_block_attributes as $attribute_name ) {
                 // Retain any non-pattern override bindings that might be present.
                 $updated_bindings[ $attribute_name ] = isset( $bindings[ $attribute_name ] )
@@ -335 +364 @@
         foreach ( $bindings as $attribute_name => $block_binding ) {
             // If the attribute is not in the supported list, process next attribute.
-            if ( ! in_array( $attribute_name, $supported_block_attributes[ $this->name ], true ) ) {
+            if ( ! in_array( $attribute_name, $supported_block_attributes, true ) ) {
                 continue;
             }

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

@@ -18 +18 @@
 
     /**
+     * Sets up shared fixtures.
+     *
+     * @since 6.9.0
+     */
+    public static function wpSetUpBeforeClass() {
+        register_block_type(
+            'test/block',
+            array(
+                'attributes'      => array(
+                    'myAttribute' => array(
+                        'type' => 'string',
+                    ),
+                ),
+                'render_callback' => function ( $attributes ) {
+                    return '<p>' . esc_html( $attributes['myAttribute'] ) . '</p>';
+                },
+            )
+        );
+    }
+
+    /**
      * Tear down after each test.
      *
@@ -33 +54 @@
 
     /**
+     * Tear down after class.
+     *
+     * @since 6.9.0
+     */
+    public static function wpTearDownAfterClass() {
+        unregister_block_type( 'test/block' );
+    }
+
+    /**
      * Test if the block content is updated with the value returned by the source.
      *
@@ -65 +95 @@
             $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.'
+        );
+    }
+
+    /**
+     * Test if the block_bindings_supported_attributes_{$block_type} filter is applied correctly.
+     *
+     * @ticket 62090
+     */
+    public function test_filter_block_bindings_supported_attributes() {
+        $get_value_callback = function () {
+            return 'test source value';
+        };
+
+        register_block_bindings_source(
+            self::SOURCE_NAME,
+            array(
+                'label'              => self::SOURCE_LABEL,
+                'get_value_callback' => $get_value_callback,
+            )
+        );
+
+        add_filter(
+            'block_bindings_supported_attributes_test/block',
+            function ( $supported_attributes ) {
+                $supported_attributes[] = 'myAttribute';
+                return $supported_attributes;
+            }
+        );
+
+        $block_content = <<<HTML
+<!-- wp:test/block {"metadata":{"bindings":{"myAttribute":{"source":"test/source"}}}} -->
+<p>This should not appear</p>
+<!-- /wp:test/block -->
+HTML;
+        $parsed_blocks = parse_blocks( $block_content );
+        $block         = new WP_Block( $parsed_blocks[0] );
+        $result        = $block->render();
+
+        $this->assertSame(
+            'test source value',
+            $block->attributes['myAttribute'],
+            "The 'myAttribute' attribute should be updated with the value returned by the source."
         );
         $this->assertSame(