Changeset 56064

Timestamp:

06/27/2023 11:26:12 AM (15 months ago)

Author:

spacedmonkey

Message:

Script Loader: Fix performance issues in wp_common_block_scripts_and_styles.

In [52069] the function wp_common_block_scripts_and_styles was changed load individual theme stylesheets, if the current theme supports block styles and loading separate core block assets. To do this, the function calls many expensive file operation functions, such as glob, file_exists and file_get_contents. This is wasteful, as these functions are loaded on every page request, even request that do not include blocks, like REST API calls. In [56044] all core block styles are registered in a single place. In register_core_block_style_handles calls glob to get all css styles in block directories. While registering style and editor styles, also register block theme styles, under a new style handle. Example wp-block-avatar-theme. If the current theme supports block styles, also request the block to enqueue the theme style on the front end. As these new stylesheets have a path attribute set, the function wp_maybe_inline_styles will automatically inline the styles for you.

Props spacedmonkey, flixos90, oandregal, costdev, audrasjb, mukesh27.
Fixes #58560.

Location:

trunk

Files:

• src/wp-includes/blocks.php (modified) (1 diff)
• src/wp-includes/blocks/index.php (modified) (3 diffs)
• src/wp-includes/script-loader.php (modified) (1 diff)
• tests/phpunit/tests/blocks/registerCoreBlockStyleHandles.php (modified) (3 diffs)

trunk/src/wp-includes/blocks.php

@@ -373 +373 @@
         if ( ! isset( $metadata['style'] ) ) {
             $metadata['style'] = "wp-block-$block_name";
+        }
+        if ( current_theme_supports( 'wp-block-styles' ) && wp_should_load_separate_core_block_assets() ) {
+            $metadata['style']   = (array) $metadata['style'];
+            $metadata['style'][] = "wp-block-{$block_name}-theme";
         }
         if ( ! isset( $metadata['editorStyle'] ) ) {

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

@@ -56 +56 @@
     }
 
+    $register_style = static function( $name, $filename, $style_handle ) use ( $includes_path, $includes_url, $suffix, $wp_styles, $files ) {
+        $style_path = "blocks/{$name}/{$filename}{$suffix}.css";
+        $path       = $includes_path . $style_path;
+
+        if ( ! in_array( $path, $files, true ) ) {
+            $wp_styles->add(
+                $style_handle,
+                false
+            );
+            return;
+        }
+
+        $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 );
+        }
+    };
+
     foreach ( $core_blocks_meta as $name => $schema ) {
         /** This filter is documented in wp-includes/blocks.php */
@@ -68 +91 @@
         }
 
+        // Register block theme styles.
+        $register_style( $name, 'theme', "wp-block-{$name}-theme" );
+
         foreach ( $style_fields as $style_field => $filename ) {
             $style_handle = $schema[ $style_field ];
@@ -73 +99 @@
                 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 );
-            }
+            $register_style( $name, $filename, $style_handle );
         }
     }

trunk/src/wp-includes/script-loader.php

@@ -2373 +2373 @@
     wp_enqueue_style( 'wp-block-library' );
 
-    if ( current_theme_supports( 'wp-block-styles' ) ) {
-        if ( wp_should_load_separate_core_block_assets() ) {
-            $suffix = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? 'css' : 'min.css';
-            $files  = glob( __DIR__ . "/blocks/**/theme.$suffix" );
-            foreach ( $files as $path ) {
-                $block_name = basename( dirname( $path ) );
-                if ( is_rtl() && file_exists( __DIR__ . "/blocks/$block_name/theme-rtl.$suffix" ) ) {
-                    $path = __DIR__ . "/blocks/$block_name/theme-rtl.$suffix";
-                }
-                wp_add_inline_style( "wp-block-{$block_name}", file_get_contents( $path ) );
-            }
-        } else {
-            wp_enqueue_style( 'wp-block-library-theme' );
-        }
+    if ( current_theme_supports( 'wp-block-styles' ) && ! wp_should_load_separate_core_block_assets() ) {
+        wp_enqueue_style( 'wp-block-library-theme' );
     }
 

trunk/tests/phpunit/tests/blocks/registerCoreBlockStyleHandles.php

@@ -56 +56 @@
      *
      * @dataProvider data_block_data
+     *
+     * @param string $name   The block name.
+     * @param array  $schema The block's schema.
      */
     public function test_wp_should_load_separate_core_block_assets_false( $name, $schema ) {
@@ -75 +78 @@
      *
      * @dataProvider data_block_data
+     *
+     * @param string $name   The block name.
+     * @param array  $schema The block's schema.
      */
     public function test_wp_should_load_separate_core_block_assets_true( $name, $schema ) {
@@ -100 +106 @@
     }
 
+    /**
+     * @ticket 58560
+     *
+     * @dataProvider data_block_data
+     *
+     * @param string $name The block name.
+     */
+    public function test_wp_should_load_separate_core_block_assets_current_theme_supports( $name ) {
+        add_filter( 'should_load_separate_core_block_assets', '__return_true' );
+        add_theme_support( 'wp-block-styles' );
+        register_core_block_style_handles();
+
+        $wp_styles = $GLOBALS['wp_styles'];
+
+        $style_handle = "wp-block-{$name}-theme";
+
+        $this->assertArrayHasKey( $style_handle, $wp_styles->registered, 'The key should exist, as this style should be registered' );
+        if ( false === $wp_styles->registered[ $style_handle ]->src ) {
+            $this->assertEmpty( $wp_styles->registered[ $style_handle ]->extra, 'If source is false, not style path should be set' );
+        } else {
+            $this->assertStringContainsString( $this->includes_url, $wp_styles->registered[ $style_handle ]->src, 'Source of style should contain the includes url' );
+            $this->assertNotEmpty( $wp_styles->registered[ $style_handle ]->extra, 'The path of the style should exist' );
+            $this->assertArrayHasKey( 'path', $wp_styles->registered[ $style_handle ]->extra, 'The path key of the style should exist in extra array' );
+            $this->assertNotEmpty( $wp_styles->registered[ $style_handle ]->extra['path'], 'The path key of the style should not be empty' );
+        }
+    }
 
     public function data_block_data() {