Changeset 59874

Timestamp:

02/26/2025 07:38:08 PM (18 months ago)

Author:

flixos90

Message:

Editor: Allow registering block type collections with a single function call.

[59132] introduced the wp_register_block_metadata_collection() function and underlying WP_Block_Metadata_Registry class to allow central registration of a block metadata PHP manifest file in favor of parsing individual JSON files. While this improves performance, it only increases the amount of APIs and code that plugin developers need to use to register their block types properly.

This changeset introduces a new function wp_register_block_types_from_metadata_collection() that improves the developer experience of registering block types from a single source, by handling it in only a single function call.

Developers that already use a generated block metadata PHP manifest file (e.g. via the wp-scripts build-blocks-manifest tool) can now call wp_register_block_types_from_metadata_collection() with that file to automatically register all block types from that block metadata collection. Individual calls to register_block_type() or register_block_type_from_metadata() are no longer necessary when the new function is used.

Props flixos90, gziolo, joemcgill, mreishus, mukesh27, swissspidy.
Fixes #62267.
See #62002.

Location:

trunk

Files:

• src/wp-includes/blocks.php (modified) (1 diff)
• src/wp-includes/class-wp-block-metadata-registry.php (modified) (1 diff)
• tests/phpunit/tests/blocks/wpBlockMetadataRegistry.php (modified) (2 diffs)

trunk/src/wp-includes/blocks.php

@@ -374 +374 @@
 
         return $i18n_block_schema;
+}
+
+/**
+ * Registers all block types from a block metadata collection.
+ *
+ * This can either reference a previously registered metadata collection or, if the `$manifest` parameter is provided,
+ * register the metadata collection directly within the same function call.
+ *
+ * @since 6.8.0
+ * @see wp_register_block_metadata_collection()
+ * @see register_block_type_from_metadata()
+ *
+ * @param string $path     The absolute base path for the collection ( e.g., WP_PLUGIN_DIR . '/my-plugin/blocks/' ).
+ * @param string $manifest Optional. The absolute path to the manifest file containing the metadata collection, in
+ *                         order to register the collection. If this parameter is not provided, the `$path` parameter
+ *                         must reference a previously registered block metadata collection.
+ */
+function wp_register_block_types_from_metadata_collection( $path, $manifest = '' ) {
+        if ( $manifest ) {
+                wp_register_block_metadata_collection( $path, $manifest );
+        }
+
+        $block_metadata_files = WP_Block_Metadata_Registry::get_collection_block_metadata_files( $path );
+        foreach ( $block_metadata_files as $block_metadata_file ) {
+                register_block_type_from_metadata( $block_metadata_file );
+        }
 }
 

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

@@ -181 +181 @@
 
         /**
+         * Gets the list of absolute paths to all block metadata files that are part of the given collection.
+         *
+         * For instance, if a block metadata collection is registered with path `WP_PLUGIN_DIR . '/my-plugin/blocks/'`,
+         * and the manifest file includes metadata for two blocks `'block-a'` and `'block-b'`, the result of this method
+         * will be an array containing:
+         * * `WP_PLUGIN_DIR . '/my-plugin/blocks/block-a/block.json'`
+         * * `WP_PLUGIN_DIR . '/my-plugin/blocks/block-b/block.json'`
+         *
+         * @since 6.8.0
+         *
+         * @param string $path The absolute base path for a previously registered collection.
+         * @return string[] List of block metadata file paths, or an empty array if the given `$path` is invalid.
+         */
+        public static function get_collection_block_metadata_files( $path ) {
+                $path = wp_normalize_path( rtrim( $path, '/' ) );
+
+                if ( ! isset( self::$collections[ $path ] ) ) {
+                        _doing_it_wrong(
+                                __METHOD__,
+                                __( 'No registered block metadata collection was found for the provided path.' ),
+                                '6.8.0'
+                        );
+                        return array();
+                }
+
+                $collection = &self::$collections[ $path ];
+
+                if ( null === $collection['metadata'] ) {
+                        // Load the manifest file if not already loaded.
+                        $collection['metadata'] = require $collection['manifest'];
+                }
+
+                return array_map(
+                        static function ( $block_name ) use ( $path ) {
+                                return "{$path}/{$block_name}/block.json";
+                        },
+                        array_keys( $collection['metadata'] )
+                );
+        }
+
+        /**
          * Finds the collection path for a given file or folder.
          *

trunk/tests/phpunit/tests/blocks/wpBlockMetadataRegistry.php

@@ -5 +5 @@
  *
  * @group blocks
+ * @coversDefaultClass WP_Block_Metadata_Registry
  */
 class Tests_Blocks_WpBlockMetadataRegistry extends WP_UnitTestCase {
@@ -189 +190 @@
                 $this->assertFalse( $result, 'Non-existent manifest should not be registered' );
         }
+
+        /**
+         * Tests that the `get_collection_block_metadata_files()` method returns the expected list of block metadata files.
+         *
+         * @ticket 62267
+         * @covers ::get_collection_block_metadata_files
+         */
+        public function test_get_collection_block_metadata_files() {
+                $path          = WP_PLUGIN_DIR . '/test-plugin/data/block-types';
+                $manifest_data = array(
+                        'a-block'       => array(
+                                'name'  => 'a-block',
+                                'title' => 'A Block',
+                        ),
+                        'another-block' => array(
+                                'name'  => 'another-block',
+                                'title' => 'Another Block',
+                        ),
+                );
+
+                file_put_contents( $this->temp_manifest_file, '<?php return ' . var_export( $manifest_data, true ) . ';' );
+
+                $this->assertTrue( WP_Block_Metadata_Registry::register_collection( $path, $this->temp_manifest_file ) );
+                $this->assertSame(
+                        array(
+                                WP_PLUGIN_DIR . '/test-plugin/data/block-types/a-block/block.json',
+                                WP_PLUGIN_DIR . '/test-plugin/data/block-types/another-block/block.json',
+                        ),
+                        WP_Block_Metadata_Registry::get_collection_block_metadata_files( $path )
+                );
+        }
 }