Changeset 59132

Timestamp:

09/30/2024 05:05:37 PM (2 months ago)

Author:

flixos90

Message:

Editor: Allow registering PHP manifest file for block metadata collections for enhanced performance.

Typically, when registering a new block type, its metadata is read from the provided block.json file. The more block types are registered on a site, the more costly becomes this process, as it involves filesystem reads and parsing JSON.

WordPress Core's built-in blocks have in the past worked around that by having a auto-generated PHP manifest file that includes the already parsed JSON data for all blocks. This changeset effectively allows plugins to do the same, by introducing a new API function wp_register_block_metadata_collection(). The WordPress Core block manifest is now handled using this API as well, rather than custom logic baked into register_block_type_from_metadata().

The wp_register_block_metadata_collection() function requires two parameters:

• $path: The base path in which block files for the collection reside.
• $manifest: The path to the manifest file for the collection.

Every block.json file that is supposed to be part of the collection must reside within the provided $path, within its own block-specific directory matching the block name (without the block namespace). For example, for a collection $path of /wp-content/plugins/test-plugin and a block test-plugin/testimonial, the block file could be /wp-content/plugins/test-plugins/blocks/testimonial/block.json.

It is recommended that plugins use the new API function for enhanced performance, especially if they register several block types. However, the use of the function is entirely optional. Not using it will not result in any difference in user-facing behavior.

Props mreishus, flixos90, gziolo, spacedmonkey, azaozz, mukesh27.
Fixes #62002.

Location:

trunk

Files:

• src/wp-includes/blocks.php (modified) (3 diffs)
• src/wp-includes/blocks/index.php (modified) (1 diff)
• src/wp-includes/class-wp-block-metadata-registry.php (added)
• src/wp-settings.php (modified) (1 diff)
• tests/phpunit/tests/blocks/registerBlockTypeFromMetadataWithRegistry.php (added)
• tests/phpunit/tests/blocks/wpBlockMetadataRegistry.php (added)

trunk/src/wp-includes/blocks.php

@@ -377 +377 @@
 
 /**
+ * Registers a block metadata collection.
+ *
+ * This function allows core and third-party plugins to register their block metadata
+ * collections in a centralized location. Registering collections can improve performance
+ * by avoiding multiple reads from the filesystem and parsing JSON.
+ *
+ * @since 6.7.0
+ *
+ * @param string $path     The base path in which block files for the collection reside.
+ * @param string $manifest The path to the manifest file for the collection.
+ */
+function wp_register_block_metadata_collection( $path, $manifest ) {
+    WP_Block_Metadata_Registry::register_collection( $path, $manifest );
+}
+
+/**
  * Registers a block type from the metadata stored in the `block.json` file.
  *
@@ -403 +419 @@
      * Using a static variable ensures that the metadata is only read once per request.
      */
-    static $core_blocks_meta;
-    if ( ! $core_blocks_meta ) {
-        $core_blocks_meta = require ABSPATH . WPINC . '/blocks/blocks-json.php';
-    }
 
     $metadata_file = ( ! str_ends_with( $file_or_folder, 'block.json' ) ) ?
@@ -412 +424 @@
         $file_or_folder;
 
-    $is_core_block = str_starts_with( $file_or_folder, ABSPATH . WPINC );
-    // If the block is not a core block, the metadata file must exist.
+    $is_core_block        = str_starts_with( $file_or_folder, ABSPATH . WPINC );
     $metadata_file_exists = $is_core_block || file_exists( $metadata_file );
-    if ( ! $metadata_file_exists && empty( $args['name'] ) ) {
-        return false;
-    }
-
-    // Try to get metadata from the static cache for core blocks.
-    $metadata = array();
-    if ( $is_core_block ) {
-        $core_block_name = str_replace( ABSPATH . WPINC . '/blocks/', '', $file_or_folder );
-        if ( ! empty( $core_blocks_meta[ $core_block_name ] ) ) {
-            $metadata = $core_blocks_meta[ $core_block_name ];
-        }
-    }
-
-    // If metadata is not found in the static cache, read it from the file.
-    if ( $metadata_file_exists && empty( $metadata ) ) {
+    $registry_metadata    = WP_Block_Metadata_Registry::get_metadata( $file_or_folder );
+
+    if ( $registry_metadata ) {
+        $metadata = $registry_metadata;
+    } elseif ( $metadata_file_exists ) {
         $metadata = wp_json_file_decode( $metadata_file, array( 'associative' => true ) );
+    } else {
+        $metadata = array();
     }
 

trunk/src/wp-includes/blocks/index.php

@@ -161 +161 @@
 }
 add_action( 'init', 'register_core_block_types_from_metadata' );
+
+/**
+ * Registers the core block metadata collection.
+ *
+ * This function is hooked into the 'init' action with a priority of 9,
+ * ensuring that the core block metadata is registered before the regular
+ * block initialization that happens at priority 10.
+ *
+ * @since 6.7.0
+ */
+function wp_register_core_block_metadata_collection() {
+    wp_register_block_metadata_collection(
+        BLOCKS_PATH,
+        BLOCKS_PATH . 'blocks-json.php'
+    );
+}
+add_action( 'init', 'wp_register_core_block_metadata_collection', 9 );

trunk/src/wp-settings.php

@@ -356 +356 @@
 require ABSPATH . WPINC . '/class-wp-block.php';
 require ABSPATH . WPINC . '/class-wp-block-list.php';
+require ABSPATH . WPINC . '/class-wp-block-metadata-registry.php';
 require ABSPATH . WPINC . '/class-wp-block-parser-block.php';
 require ABSPATH . WPINC . '/class-wp-block-parser-frame.php';