Changeset 58972

Timestamp:

09/03/2024 04:31:44 PM (5 weeks ago)

Author:

cbravobernal

Message:

Block bindings: Adds a filter to customize the output of a block bindings source.

Introduces a filter to the block_bindings_source_value to allow developers to
modify the value returned by any block binding source.

Props snehapatil02, cbravobernal, gziolo, santosguillamot, bacoords, codersantosh.
Fixes #61181.

Location:

trunk

Files:

• src/wp-includes/class-wp-block-bindings-source.php (modified) (3 diffs)
• tests/phpunit/tests/block-bindings/postMetaSource.php (modified) (1 diff)
• tests/phpunit/tests/block-bindings/render.php (modified) (1 diff)

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

@@ -2 +2 @@
 /**
  * Block Bindings API: WP_Block_Bindings_Source class.
- *
  *
  * @package WordPress
@@ -61 +60 @@
      * @since 6.5.0
      *
-     * @param string $name               The name of the source.
-     * @param array  $source_properties  The properties of the source.
+     * @param string $name              The name of the source.
+     * @param array  $source_properties The properties of the source.
      */
     public function __construct( string $name, array $source_properties ) {
@@ -72 +71 @@
 
     /**
-     * Retrieves the value from the source.
+     * Calls the callback function specified in the `$get_value_callback` property
+     * with the given arguments and returns the result. It can be modified with
+     * `block_bindings_source_value` filter.
      *
      * @since 6.5.0
+     * @since 6.7.0 `block_bindings_source_value` filter was added.
      *
-     * @param array    $source_args     Array containing source arguments used to look up the override value, i.e. {"key": "foo"}.
-     * @param WP_Block $block_instance  The block instance.
-     * @param string   $attribute_name  The name of the target attribute.
-     *
+     * @param array    $source_args    Array containing source arguments used to look up the override value, i.e. {"key": "foo"}.
+     * @param WP_Block $block_instance The block instance.
+     * @param string   $attribute_name The name of the target attribute.
      * @return mixed The value of the source.
      */
     public function get_value( array $source_args, $block_instance, string $attribute_name ) {
-        return call_user_func_array( $this->get_value_callback, array( $source_args, $block_instance, $attribute_name ) );
+        $value = call_user_func_array( $this->get_value_callback, array( $source_args, $block_instance, $attribute_name ) );
+        /**
+         * Filters the output of a block bindings source.
+         *
+         * @since 6.7.0
+         *
+         * @param mixed    $value          The computed value for the source.
+         * @param string   $name           The name of the source.
+         * @param array    $source_args    Array containing source arguments used to look up the override value, i.e. { "key": "foo" }.
+         * @param WP_Block $block_instance The block instance.
+         * @param string   $attribute_name The name of an attribute.
+         */
+        return apply_filters( 'block_bindings_source_value', $value, $this->name, $source_args, $block_instance, $attribute_name );
     }
 

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

@@ -267 +267 @@
         );
     }
+
+    /**
+     * Tests that filter `block_bindings_source_value` is applied.
+     *
+     * @ticket 61181
+     */
+    public function test_filter_block_bindings_source_value() {
+        register_meta(
+            'post',
+            'tests_filter_field',
+            array(
+                'show_in_rest' => true,
+                'single'       => true,
+                'type'         => 'string',
+                'default'      => 'Original value',
+            )
+        );
+
+        $filter_value = function ( $value, $source_name, $source_args ) {
+            if ( 'core/post-meta' !== $source_name ) {
+                return $value;
+            }
+            return "Filtered value: {$source_args['key']}";
+        };
+
+        add_filter( 'block_bindings_source_value', $filter_value, 10, 3 );
+
+        $content = $this->get_modified_post_content( '<!-- wp:paragraph {"metadata":{"bindings":{"content":{"source":"core/post-meta","args":{"key":"tests_filter_field"}}}}} --><p>Fallback value</p><!-- /wp:paragraph -->' );
+
+        remove_filter( 'block_bindings_source_value', $filter_value );
+
+        $this->assertSame(
+            '<p>Filtered value: tests_filter_field</p>',
+            $content,
+            'The post content should show the filtered value.'
+        );
+    }
 }

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

@@ -299 +299 @@
         );
     }
+
+    /**
+     * Tests that filter `block_bindings_source_value` is applied.
+     *
+     * @ticket 61181
+     */
+    public function test_filter_block_bindings_source_value() {
+        register_block_bindings_source(
+            self::SOURCE_NAME,
+            array(
+                'label'              => self::SOURCE_LABEL,
+                'get_value_callback' => function () {
+                    return '';
+                },
+            )
+        );
+
+        $filter_value = function ( $value, $source_name, $source_args, $block_instance, $attribute_name ) {
+            if ( self::SOURCE_NAME !== $source_name ) {
+                return $value;
+            }
+            return "Filtered value: {$source_args['test_key']}. Block instance: {$block_instance->name}. Attribute name: {$attribute_name}.";
+        };
+
+        add_filter( 'block_bindings_source_value', $filter_value, 10, 5 );
+
+        $block_content = <<<HTML
+<!-- wp:paragraph {"metadata":{"bindings":{"content":{"source":"test/source", "args":{"test_key":"test_arg"}}}}} -->
+<p>Default content</p>
+<!-- /wp:paragraph -->
+HTML;
+        $parsed_blocks = parse_blocks( $block_content );
+        $block         = new WP_Block( $parsed_blocks[0] );
+        $result        = $block->render();
+
+        remove_filter( 'block_bindings_source_value', $filter_value );
+
+        $this->assertSame(
+            '<p>Filtered value: test_arg. Block instance: core/paragraph. Attribute name: content.</p>',
+            trim( $result ),
+            'The block content should show the filtered value.'
+        );
+    }
 }