Changeset 56044

Timestamp:

06/26/2023 09:15:21 PM (5 months ago)

Author:

spacedmonkey

Message:

Editor: Register core block styles in one place.

Register all core blocks in a new function called register_core_block_style_handles. This mirrors the function wp_default_styles where all core styles are registered in one place. This improves block registration performance, as it avoids expensive file lookups, like realpath in register_block_style_handle. The new function register_core_block_style_handles uses glob to get all css files in the blocks directory. This glob is cached in a transient to save lookups on subsequent requests. The function register_block_style_handle now checks to see if the style handle is already registered before trying to register it again.

Props mukesh27, westonruter, flixos90, joemcgill, spacedmonkey.
Fixes #58528.

Location:

trunk

Files:

• src/wp-admin/includes/upgrade.php (modified) (1 diff)
• src/wp-includes/blocks.php (modified) (6 diffs)
• src/wp-includes/blocks/index.php (modified) (1 diff)
• tests/phpunit/tests/blocks/register.php (modified) (3 diffs)
• tests/phpunit/tests/blocks/registerCoreBlockStyleHandles.php (added)

trunk/src/wp-admin/includes/upgrade.php

@@ -655 +655 @@
         }
 
+        delete_transient( 'wp_core_block_css_files' );
+
         /**
          * Fires after a site is fully upgraded.

trunk/src/wp-includes/blocks.php

@@ -187 +187 @@
     }
 
+    $style_handle = $metadata[ $field_name ];
+    if ( is_array( $style_handle ) ) {
+        if ( empty( $style_handle[ $index ] ) ) {
+            return false;
+        }
+        $style_handle = $style_handle[ $index ];
+    }
+
+    $style_handle_name = generate_block_asset_handle( $metadata['name'], $field_name, $index );
+    // If the style handle is already registered, skip re-registering.
+    if ( wp_style_is( $style_handle_name, 'registered' ) ) {
+        return $style_handle_name;
+    }
+
     static $wpinc_path_norm = '';
     if ( ! $wpinc_path_norm ) {
@@ -196 +210 @@
     if ( $is_core_block && ! wp_should_load_separate_core_block_assets() ) {
         return false;
-    }
-
-    $style_handle = $metadata[ $field_name ];
-    if ( is_array( $style_handle ) ) {
-        if ( empty( $style_handle[ $index ] ) ) {
-            return false;
-        }
-        $style_handle = $style_handle[ $index ];
     }
 
@@ -247 +253 @@
     }
 
-    $style_handle = generate_block_asset_handle( $metadata['name'], $field_name, $index );
-    $version      = ! $is_core_block && isset( $metadata['version'] ) ? $metadata['version'] : false;
-    $result       = wp_register_style(
-        $style_handle,
+    $version = ! $is_core_block && isset( $metadata['version'] ) ? $metadata['version'] : false;
+    $result  = wp_register_style(
+        $style_handle_name,
         $style_uri,
         array(),
@@ -260 +265 @@
 
     if ( $has_style_file ) {
-        wp_style_add_data( $style_handle, 'path', $style_path_norm );
+        wp_style_add_data( $style_handle_name, 'path', $style_path_norm );
 
         if ( $is_core_block ) {
@@ -269 +274 @@
 
         if ( is_rtl() && file_exists( $rtl_file ) ) {
-            wp_style_add_data( $style_handle, 'rtl', 'replace' );
-            wp_style_add_data( $style_handle, 'suffix', $suffix );
-            wp_style_add_data( $style_handle, 'path', $rtl_file );
-        }
-    }
-
-    return $style_handle;
+            wp_style_add_data( $style_handle_name, 'rtl', 'replace' );
+            wp_style_add_data( $style_handle_name, 'suffix', $suffix );
+            wp_style_add_data( $style_handle_name, 'path', $rtl_file );
+        }
+    }
+
+    return $style_handle_name;
 }
 
@@ -321 +326 @@
     static $core_blocks_meta;
     if ( ! $core_blocks_meta ) {
-        $core_blocks_meta = require_once ABSPATH . WPINC . '/blocks/blocks-json.php';
+        $core_blocks_meta = require ABSPATH . WPINC . '/blocks/blocks-json.php';
     }
 

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

@@ -12 +12 @@
 require BLOCKS_PATH . 'widget-group.php';
 require BLOCKS_PATH . 'require-dynamic-blocks.php';
+
+/**
+ * Registers core block style handles.
+ *
+ * While {@see register_block_style_handle()} is typically used for that, the way it is
+ * implemented is inefficient for core block styles. Registering those style handles here
+ * avoids unnecessary logic and filesystem lookups in the other function.
+ *
+ * @since 6.3.0
+ */
+function register_core_block_style_handles() {
+    if ( ! wp_should_load_separate_core_block_assets() ) {
+        return;
+    }
+
+    static $core_blocks_meta;
+    if ( ! $core_blocks_meta ) {
+        $core_blocks_meta = require ABSPATH . WPINC . '/blocks/blocks-json.php';
+    }
+
+    $includes_url  = includes_url();
+    $includes_path = ABSPATH . WPINC . '/';
+    $suffix        = wp_scripts_get_suffix();
+    $wp_styles     = wp_styles();
+    $style_fields  = array(
+        'style'       => 'style',
+        'editorStyle' => 'editor',
+    );
+
+    /*
+     * Ignore transient cache when the development mode is set to 'core'. Why? To avoid interfering with
+     * the core developer's workflow.
+     */
+    if ( 'core' !== wp_get_development_mode() ) {
+        $transient_name = 'wp_core_block_css_files';
+        $files          = get_transient( $transient_name );
+        if ( ! $files ) {
+            $files = glob( __DIR__ . '/**/**.css' );
+            set_transient( $transient_name, $files );
+        }
+    } else {
+        $files = glob( __DIR__ . '/**/**.css' );
+    }
+
+    foreach ( $core_blocks_meta as $name => $schema ) {
+        /** This filter is documented in wp-includes/blocks.php */
+        $schema = apply_filters( 'block_type_metadata', $schema );
+
+        // Backfill these properties similar to `register_block_type_from_metadata()`.
+        if ( ! isset( $schema['style'] ) ) {
+            $schema['style'] = "wp-block-{$name}";
+        }
+        if ( ! isset( $schema['editorStyle'] ) ) {
+            $schema['editorStyle'] = "wp-block-{$name}-editor";
+        }
+
+        foreach ( $style_fields as $style_field => $filename ) {
+            $style_handle = $schema[ $style_field ];
+            if ( is_array( $style_handle ) ) {
+                continue;
+            }
+
+            $style_path = "blocks/{$name}/{$filename}{$suffix}.css";
+            $path       = $includes_path . $style_path;
+
+            if ( ! in_array( $path, $files, true ) ) {
+                $wp_styles->add(
+                    $style_handle,
+                    false
+                );
+                continue;
+            }
+
+            $wp_styles->add( $style_handle, $includes_url . $style_path );
+            $wp_styles->add_data( $style_handle, 'path', $path );
+
+            $rtl_file = str_replace( "{$suffix}.css", "-rtl{$suffix}.css", $path );
+            if ( is_rtl() && in_array( $rtl_file, $files, true ) ) {
+                $wp_styles->add_data( $style_handle, 'rtl', 'replace' );
+                $wp_styles->add_data( $style_handle, 'suffix', $suffix );
+                $wp_styles->add_data( $style_handle, 'path', $rtl_file );
+            }
+        }
+    }
+}
+add_action( 'init', 'register_core_block_style_handles', 9 );
 
 /**

trunk/tests/phpunit/tests/blocks/register.php

@@ -398 +398 @@
     public function test_handle_passed_register_block_style_handle() {
         $metadata = array(
+            'name'  => 'test-block',
             'style' => 'test-style-handle',
         );
@@ -407 +408 @@
     public function test_handles_passed_register_block_style_handles() {
         $metadata = array(
+            'name'  => 'test-block',
             'style' => array( 'test-style-handle', 'test-style-handle-2' ),
         );
@@ -522 +524 @@
         $this->assertSame( $expected_style_handle, $result );
         $this->assertFalse( wp_styles()->get_data( $expected_style_handle, 'rtl' ) );
+    }
+
+    /**
+     * @ticket 58528
+     *
+     * @covers ::register_block_style_handle
+     */
+    public function test_success_register_block_style_handle_exists() {
+        $expected_style_handle = 'block-theme-example-block-editor-style';
+        wp_register_style( $expected_style_handle, false );
+        switch_theme( 'block-theme' );
+
+        $metadata = array(
+            'file'        => wp_normalize_path( get_theme_file_path( 'blocks/example-block/block.json' ) ),
+            'name'        => 'block-theme/example-block',
+            'editorStyle' => 'file:./editor-style.css',
+        );
+        $result   = register_block_style_handle( $metadata, 'editorStyle' );
+
+        $this->assertSame( $expected_style_handle, $result );
     }