Changeset 59823

Timestamp:

02/14/2025 06:36:48 PM (3 months ago)

Author:

flixos90

Message:

Editor: Introduce wp_should_load_block_assets_on_demand() with filter 'should_load_block_assets_on_demand'.

This function and filter complement the existing wp_should_load_separate_core_block_assets() with filter 'should_load_separate_core_block_assets', which until now was responsible for two different purposes:

1. Loading separate stylesheets for Core blocks, instead of a combined wp-block-library stylesheet (as the name indicates).
2. Loading block scripts and stylesheets on demand only if the blocks are included in the page (not indicated by the name).

The new function and filter handles exclusively the 2nd purpose, making it possible to individually adjust both behaviors. For backward compatibility, the return value of wp_should_load_separate_core_block_assets() is used as the filterable default for wp_should_load_block_assets_on_demand(). Yet, the two filters can now be individually be controlled: For example, a site owner that wants to keep loading the combined wp-block-library stylesheet can now do so without giving up on the ability to load block scripts and stylesheets on demand.

Block themes now opt in by default to both features, similar to how they were already doing before via just the one filter. This way, block themes that opt out of loading separate stylesheets for Core blocks will still benefit from loading block scripts and stylesheets on demand, which in the case of block themes is strongly recommended.

Props fabiankaegy, flixos90, gziolo.
Fixes #61965.

Location:

trunk

Files:

• src/wp-includes/class-wp-block.php (modified) (1 diff)
• src/wp-includes/global-styles-and-settings.php (modified) (3 diffs)
• src/wp-includes/script-loader.php (modified) (9 diffs)
• src/wp-includes/theme.php (modified) (1 diff)
• tests/phpunit/tests/theme.php (modified) (1 diff)

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

@@ -609 +609 @@
         }
 
+        /*
+         * For Core blocks, these styles are only enqueued if `wp_should_load_separate_core_block_assets()` returns
+         * true. Otherwise these `wp_enqueue_style()` calls will not have any effect, as the Core blocks are relying on
+         * the combined 'wp-block-library' stylesheet instead, which is unconditionally enqueued.
+         */
         if ( ( ! empty( $this->block_type->style_handles ) ) ) {
             foreach ( $this->block_type->style_handles as $style_handle ) {

trunk/src/wp-includes/global-styles-and-settings.php

@@ -299 +299 @@
         }
 
-        if ( ! wp_should_load_separate_core_block_assets() ) {
+        if ( ! wp_should_load_block_assets_on_demand() ) {
             wp_add_inline_style( 'global-styles', $block_css );
             continue;
@@ -307 +307 @@
 
         /*
-         * When `wp_should_load_separate_core_block_assets()` is true, block styles are
+         * When `wp_should_load_block_assets_on_demand()` is true, block styles are
          * enqueued for each block on the page in class WP_Block's render function.
          * This means there will be a handle in the styles queue for each of those blocks.
@@ -314 +314 @@
          * before adding the inline style.
          * This conditional loading only applies to core blocks.
+         * TODO: Explore how this could be expanded to third-party blocks as well.
          */
         if ( isset( $metadata['name'] ) ) {

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

@@ -2488 +2488 @@
  */
 function wp_enqueue_global_styles() {
-    $separate_assets  = wp_should_load_separate_core_block_assets();
+    $assets_on_demand = wp_should_load_block_assets_on_demand();
     $is_block_theme   = wp_is_block_theme();
     $is_classic_theme = ! $is_block_theme;
 
     /*
-     * Global styles should be printed in the head when loading all styles combined.
-     * The footer should only be used to print global styles for classic themes with separate core assets enabled.
-     *
-     * See https://core.trac.wordpress.org/ticket/53494.
+     * Global styles should be printed in the head for block themes, or for classic themes when loading assets on
+     * demand is disabled, which is the default.
+     * The footer should only be used for classic themes when loading assets on demand is enabled.
+     *
+     * See https://core.trac.wordpress.org/ticket/53494 and https://core.trac.wordpress.org/ticket/61965.
      */
     if (
         ( $is_block_theme && doing_action( 'wp_footer' ) ) ||
-        ( $is_classic_theme && doing_action( 'wp_footer' ) && ! $separate_assets ) ||
-        ( $is_classic_theme && doing_action( 'wp_enqueue_scripts' ) && $separate_assets )
+        ( $is_classic_theme && doing_action( 'wp_footer' ) && ! $assets_on_demand ) ||
+        ( $is_classic_theme && doing_action( 'wp_enqueue_scripts' ) && $assets_on_demand )
     ) {
         return;
@@ -2568 +2569 @@
 
 /**
- * Checks whether separate styles should be loaded for core blocks on-render.
- *
- * When this function returns true, other functions ensure that core blocks
- * only load their assets on-render, and each block loads its own, individual
- * assets. Third-party blocks only load their assets when rendered.
- *
- * When this function returns false, all core block assets are loaded regardless
- * of whether they are rendered in a page or not, because they are all part of
- * the `block-library/style.css` file. Assets for third-party blocks are always
- * enqueued regardless of whether they are rendered or not.
+ * Checks whether separate styles should be loaded for core blocks.
+ *
+ * When this function returns true, other functions ensure that core blocks use their own separate stylesheets.
+ * When this function returns false, all core blocks will use the single combined 'wp-block-library' stylesheet.
+ *
+ * As a side effect, the return value will by default result in block assets to be loaded on demand, via the
+ * {@see wp_should_load_block_assets_on_demand()} function. This behavior can be separately altered via that function.
  *
  * This only affects front end and not the block editor screens.
  *
+ * @since 5.8.0
+ * @see @see wp_should_load_block_assets_on_demand()
  * @see wp_enqueue_registered_block_scripts_and_styles()
  * @see register_block_style_handle()
  *
- * @since 5.8.0
- *
- * @return bool Whether separate assets will be loaded.
+ * @return bool Whether separate core block assets will be loaded.
  */
 function wp_should_load_separate_core_block_assets() {
@@ -2608 +2606 @@
 
 /**
+ * Checks whether block styles should be loaded only on-render.
+ *
+ * When this function returns true, other functions ensure that blocks only load their assets on-render.
+ * When this function returns false, all block assets are loaded regardless of whether they are rendered in a page.
+ *
+ * The default return value depends on the result of {@see wp_should_load_separate_core_block_assets()}, which controls
+ * whether Core block stylesheets should be loaded separately or via a combined 'wp-block-library' stylesheet.
+ *
+ * This only affects front end and not the block editor screens.
+ *
+ * @since 6.8.0
+ * @see wp_should_load_separate_core_block_assets()
+ *
+ * @return bool Whether to load block assets only when they are rendered.
+ */
+function wp_should_load_block_assets_on_demand() {
+    if ( is_admin() || is_feed() || wp_is_rest_endpoint() ) {
+        return false;
+    }
+
+    /*
+     * For backward compatibility, the default return value for this function is based on the return value of
+     * `wp_should_load_separate_core_block_assets()`. Initially, this function used to control both of these concerns.
+     */
+    $load_assets_on_demand = wp_should_load_separate_core_block_assets();
+
+    /**
+     * Filters whether block styles should be loaded on demand.
+     *
+     * Returning false loads all block assets, regardless of whether they are rendered in a page or not.
+     * Returning true loads block assets only when they are rendered.
+     *
+     * The default value of the filter depends on the result of {@see wp_should_load_separate_core_block_assets()},
+     * which controls whether Core block stylesheets should be loaded separately or via a combined 'wp-block-library'
+     * stylesheet.
+     *
+     * @since 6.8.0
+     *
+     * @param bool $load_assets_on_demand Whether to load block assets only when they are rendered.
+     */
+    return apply_filters( 'should_load_block_assets_on_demand', $load_assets_on_demand );
+}
+
+/**
  * Enqueues registered block scripts and styles, depending on current rendered
  * context (only enqueuing editor scripts while in context of the editor).
@@ -2618 +2660 @@
     global $current_screen;
 
-    if ( wp_should_load_separate_core_block_assets() ) {
+    if ( wp_should_load_block_assets_on_demand() ) {
         return;
     }
@@ -2625 +2667 @@
 
     $block_registry = WP_Block_Type_Registry::get_instance();
+
+    /*
+     * Block styles are only enqueued if they're registered. For core blocks, this is only the case if
+     * `wp_should_load_separate_core_block_assets()` returns true. Otherwise they use the single combined
+     * 'wp-block-library` stylesheet. See also `register_core_block_style_handles()`.
+     * Since `wp_enqueue_style()` does not trigger warnings if the style is not registered, it is okay to not cater for
+     * this behavior here and simply call `wp_enqueue_style()` unconditionally.
+     */
     foreach ( $block_registry->get_all_registered() as $block_name => $block_type ) {
         // Front-end and editor styles.
@@ -2666 +2716 @@
             if ( isset( $style_properties['style_handle'] ) ) {
 
-                // If the site loads separate styles per-block, enqueue the stylesheet on render.
-                if ( wp_should_load_separate_core_block_assets() ) {
+                // If the site loads block styles on demand, enqueue the stylesheet on render.
+                if ( wp_should_load_block_assets_on_demand() ) {
                     add_filter(
                         'render_block',
@@ -2688 +2738 @@
                 $handle = 'wp-block-library';
 
-                // If the site loads separate styles per-block, check if the block has a stylesheet registered.
-                if ( wp_should_load_separate_core_block_assets() ) {
+                // If the site loads block styles on demand, check if the block has a stylesheet registered.
+                if ( wp_should_load_block_assets_on_demand() ) {
                     $block_stylesheet_handle = generate_block_asset_handle( $block_name, 'style' );
 
@@ -3188 +3238 @@
  * Enqueues a stylesheet for a specific block.
  *
- * If the theme has opted-in to separate-styles loading,
+ * If the theme has opted-in to load block styles on demand,
  * then the stylesheet will be enqueued on-render,
  * otherwise when the block inits.
@@ -3256 +3306 @@
 
     $hook = did_action( 'wp_enqueue_scripts' ) ? 'wp_footer' : 'wp_enqueue_scripts';
-    if ( wp_should_load_separate_core_block_assets() ) {
+    if ( wp_should_load_block_assets_on_demand() ) {
         /**
          * Callback function to register and enqueue styles.

trunk/src/wp-includes/theme.php

@@ -4396 +4396 @@
 
     add_filter( 'should_load_separate_core_block_assets', '__return_true' );
+    add_filter( 'should_load_block_assets_on_demand', '__return_true' );
 
     /*

trunk/tests/phpunit/tests/theme.php

@@ -967 +967 @@
 
     /**
+     * Tests that block themes load block assets on demand by default.
+     *
+     * @ticket 61965
+     *
+     * @covers ::_add_default_theme_supports
+     * @covers ::wp_should_load_block_assets_on_demand
+     */
+    public function test_block_theme_should_load_block_assets_on_demand_by_default() {
+        $this->helper_requires_block_theme();
+
+        add_filter( 'should_load_block_assets_on_demand', '__return_false' );
+
+        $this->assertFalse(
+            wp_should_load_block_assets_on_demand(),
+            'Could not disable loading block assets on demand.'
+        );
+
+        do_action( 'after_setup_theme' );
+        add_filter( 'should_load_separate_core_block_assets', '__return_false' );
+
+        $this->assertTrue(
+            wp_should_load_block_assets_on_demand(),
+            'Block themes do not load block assets on demand by default.'
+        );
+    }
+
+    /**
+     * Tests that block themes load block assets on demand by default even when loading separate core block assets is disabled.
+     *
+     * @ticket 61965
+     *
+     * @covers ::_add_default_theme_supports
+     * @covers ::wp_should_load_block_assets_on_demand
+     */
+    public function test_block_theme_should_load_block_assets_on_demand_by_default_even_with_separate_core_block_assets_disabled() {
+        $this->helper_requires_block_theme();
+
+        do_action( 'after_setup_theme' );
+        add_filter( 'should_load_separate_core_block_assets', '__return_false' );
+
+        $this->assertTrue( wp_should_load_block_assets_on_demand() );
+    }
+
+    /**
      * Tests that a theme in the custom test data theme directory is recognized.
      *