Changeset 59238

Timestamp:

10/15/2024 08:50:08 AM (3 months ago)

Author:

gziolo

Message:

Editor: Bootstrap block binding sources with inline script from server

Bootstrap block bindings sources earlier in the process through an inline script to ensure they are available when developers want to extend them in the client. Following the same pattern other APIs like registering block types are doing.

Props santosguillamot, cbravobernal, gziolo.
Fixes #6225.

Location:

trunk

Files:

• src/wp-admin/edit-form-blocks.php (modified) (1 diff)
• src/wp-admin/site-editor.php (modified) (1 diff)
• src/wp-admin/widgets-form-blocks.php (modified) (1 diff)
• src/wp-includes/block-editor.php (modified) (1 diff)
• src/wp-includes/class-wp-customize-widgets.php (modified) (1 diff)
• tests/phpunit/tests/blocks/editor.php (modified) (1 diff)

trunk/src/wp-admin/edit-form-blocks.php

@@ -106 +106 @@
     'wp.blocks.unstable__bootstrapServerSideBlockDefinitions(' . wp_json_encode( get_block_editor_server_block_settings() ) . ');'
 );
+
+// Preload server-registered block bindings sources.
+$registered_sources = get_all_registered_block_bindings_sources();
+if ( ! empty( $registered_sources ) ) {
+    $filtered_sources = array();
+    foreach ( $registered_sources as $source ) {
+        $filtered_sources[] = array(
+            'name'        => $source->name,
+            'label'       => $source->label,
+            'usesContext' => $source->uses_context,
+        );
+    }
+    $script = sprintf( 'for ( const source of %s ) { wp.blocks.registerBlockBindingsSource( source ); }', wp_json_encode( $filtered_sources ) );
+    wp_add_inline_script(
+        'wp-blocks',
+        $script
+    );
+}
 
 // Get admin url for handling meta boxes.

trunk/src/wp-admin/site-editor.php

@@ -136 +136 @@
 );
 
+// Preload server-registered block bindings sources.
+$registered_sources = get_all_registered_block_bindings_sources();
+if ( ! empty( $registered_sources ) ) {
+    $filtered_sources = array();
+    foreach ( $registered_sources as $source ) {
+        $filtered_sources[] = array(
+            'name'        => $source->name,
+            'label'       => $source->label,
+            'usesContext' => $source->uses_context,
+        );
+    }
+    $script = sprintf( 'for ( const source of %s ) { wp.blocks.registerBlockBindingsSource( source ); }', wp_json_encode( $filtered_sources ) );
+    wp_add_inline_script(
+        'wp-blocks',
+        $script
+    );
+}
+
 wp_add_inline_script(
     'wp-blocks',

trunk/src/wp-admin/widgets-form-blocks.php

@@ -51 +51 @@
     'wp.blocks.unstable__bootstrapServerSideBlockDefinitions(' . wp_json_encode( get_block_editor_server_block_settings() ) . ');'
 );
+
+// Preload server-registered block bindings sources.
+$registered_sources = get_all_registered_block_bindings_sources();
+if ( ! empty( $registered_sources ) ) {
+    $filtered_sources = array();
+    foreach ( $registered_sources as $source ) {
+        $filtered_sources[] = array(
+            'name'        => $source->name,
+            'label'       => $source->label,
+            'usesContext' => $source->uses_context,
+        );
+    }
+    $script = sprintf( 'for ( const source of %s ) { wp.blocks.registerBlockBindingsSource( source ); }', wp_json_encode( $filtered_sources ) );
+    wp_add_inline_script(
+        'wp-blocks',
+        $script
+    );
+}
 
 wp_add_inline_script(

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/src/wp-includes/class-wp-customize-widgets.php

@@ -866 +866 @@
                 'wp.blocks.unstable__bootstrapServerSideBlockDefinitions(' . wp_json_encode( get_block_editor_server_block_settings() ) . ');'
             );
+
+            // Preload server-registered block bindings sources.
+            $registered_sources = get_all_registered_block_bindings_sources();
+            if ( ! empty( $registered_sources ) ) {
+                $filtered_sources = array();
+                foreach ( $registered_sources as $source ) {
+                    $filtered_sources[] = array(
+                        'name'        => $source->name,
+                        'label'       => $source->label,
+                        'usesContext' => $source->uses_context,
+                    );
+                }
+                $script = sprintf( 'for ( const source of %s ) { wp.blocks.registerBlockBindingsSource( source ); }', wp_json_encode( $filtered_sources ) );
+                wp_add_inline_script(
+                    'wp-blocks',
+                    $script
+                );
+            }
 
             wp_add_inline_script(

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 );
-    }
 }