Changeset 54276 for trunk/src/wp-includes/blocks.php

Timestamp:

09/21/2022 01:55:25 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Editor: Improve block loading PHP performance.

This commit improves PHP performance for core blocks by reading a single PHP file with block metadata, instead of reading a JSON file per-block and then decoding from JSON to PHP.

Includes:

• Adding a new Grunt task to convert block.json files to block-json.php.
• Using the new block-json.php file in the register_block_type_from_metadata() function.

Follow-up to [48141].

Props aristath, gziolo, johnbillion, presstoke, mukesh27, hellofromTonya, petitphp, adamsilverstein, costdev, desrosj, SergeyBiryukov.
Fixes #55005.

File:

• trunk/src/wp-includes/blocks.php (modified) (1 diff)

trunk/src/wp-includes/blocks.php

@@ -284 +284 @@
  */
 function register_block_type_from_metadata( $file_or_folder, $args = array() ) {
-    $filename      = 'block.json';
-    $metadata_file = ( substr( $file_or_folder, -strlen( $filename ) ) !== $filename ) ?
-        trailingslashit( $file_or_folder ) . $filename :
+    /*
+     * Get an array of metadata from a PHP file.
+     * This improves performance for core blocks as it's only necessary to read a single PHP file
+     * instead of reading a JSON file per-block, and then decoding from JSON to PHP.
+     * 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 = include_once ABSPATH . WPINC . '/blocks/blocks-json.php';
+    }
+
+    $metadata_file = ( ! str_ends_with( $file_or_folder, 'block.json' ) ) ?
+        trailingslashit( $file_or_folder ) . 'block.json' :
         $file_or_folder;
+
     if ( ! file_exists( $metadata_file ) ) {
         return false;
     }
 
-    $metadata = wp_json_file_decode( $metadata_file, array( 'associative' => true ) );
+    // Try to get metadata from the static cache for core blocks.
+    $metadata = false;
+    if ( str_starts_with( $file_or_folder, ABSPATH . WPINC ) ) {
+        $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 ) {
+        $metadata = wp_json_file_decode( $metadata_file, array( 'associative' => true ) );
+    }
+
     if ( ! is_array( $metadata ) || empty( $metadata['name'] ) ) {
         return false;