Changeset 58798

Timestamp:

07/24/2024 10:57:27 AM (7 weeks ago)

Author:

cbravobernal

Message:

Block Bindings: Adds sources in the editor settings to consume them in the client

Adds a new property blockBindingsSources to the editor settings to expose the block bindings sources registered in the server.

Props santosguillamot, cbravobernal, gziolo, artemiosans.
Fixes #61641.

Location:

trunk

Files:

• src/wp-includes/block-editor.php (modified) (1 diff)
• tests/phpunit/tests/block-bindings/wpBlockBindingsRegistry.php (modified) (2 diffs)
• tests/phpunit/tests/blocks/editor.php (modified) (1 diff)

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

@@ -647 +647 @@
     if ( isset( $post_content_block_attributes ) ) {
         $editor_settings['postContentAttributes'] = $post_content_block_attributes;
+    }
+
+    // Expose block bindings sources in the editor settings.
+    $registered_block_bindings_sources = get_all_registered_block_bindings_sources();
+    if ( ! empty( $registered_block_bindings_sources ) ) {
+        // Initialize array.
+        $editor_settings['blockBindingsSources'] = array();
+        foreach ( $registered_block_bindings_sources as $source_name => $source_properties ) {
+            // Add source with the label to editor settings.
+            $editor_settings['blockBindingsSources'][ $source_name ] = array(
+                'label' => $source_properties->label,
+            );
+            // Add `usesContext` property if exists.
+            if ( ! empty( $source_properties->uses_context ) ) {
+                $editor_settings['blockBindingsSources'][ $source_name ]['usesContext'] = $source_properties->uses_context;
+            }
+        }
     }
 

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

@@ -312 +312 @@
         $expected = new WP_Block_Bindings_Source( $source_two_name, $source_two_properties );
         $result   = $this->registry->get_registered( 'test/source-two' );
+        $this->registry->unregister( 'test/source-one' );
+        $this->registry->unregister( 'test/source-two' );
+        $this->registry->unregister( 'test/source-three' );
 
         $this->assertEquals(
@@ -381 +384 @@
 
         $new_uses_context = $block_registry->get_registered( 'core/paragraph' )->uses_context;
+        unregister_block_bindings_source( 'test/source-one' );
+        unregister_block_bindings_source( 'test/source-two' );
         // Checks that the resulting `uses_context` contains the values from both sources.
         $this->assertContains( 'commonContext', $new_uses_context );

trunk/tests/phpunit/tests/blocks/editor.php

@@ -721 +721 @@
         );
     }
+
+    /**
+     * @ticket 61641
+     */
+    public function test_get_block_editor_settings_block_bindings_sources() {
+        $block_editor_context = new WP_Block_Editor_Context();
+        register_block_bindings_source(
+            'test/source-one',
+            array(
+                'label'              => 'Source One',
+                'get_value_callback' => function () {},
+                'uses_context'       => array( 'postId' ),
+            )
+        );
+        register_block_bindings_source(
+            'test/source-two',
+            array(
+                'label'              => 'Source Two',
+                'get_value_callback' => function () {},
+            )
+        );
+        $settings        = get_block_editor_settings( array(), $block_editor_context );
+        $exposed_sources = $settings['blockBindingsSources'];
+        unregister_block_bindings_source( 'test/source-one' );
+        unregister_block_bindings_source( 'test/source-two' );
+        // It is expected to have 4 sources: the 2 registered sources in the test, and the 2 core sources.
+        $this->assertCount( 4, $exposed_sources );
+        $source_one = $exposed_sources['test/source-one'];
+        $this->assertSame( 'Source One', $source_one['label'] );
+        $this->assertSameSets( array( 'postId' ), $source_one['usesContext'] );
+        $source_two = $exposed_sources['test/source-two'];
+        $this->assertSame( 'Source Two', $source_two['label'] );
+        $this->assertArrayNotHasKey( 'usesContext', $source_two );
+    }
 }