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

Timestamp:

10/18/2024 09:53:45 PM (7 months ago)

Author:

joemcgill

Message:

Editor: Cache global styles for blocks.

This caches the generated CSS from block nodes in merged Theme JSON data to avoid repeated costly operations required to compute style properties for blocks. The generated CSS is saved to a transient that expires every hour.

This is a follow-up that reimplements [58334], which was previously reverted in [58710].

Props thekt12, spacedmonkey, pereirinha, mukesh27, isabel_brison, oandregal, andrewserong, ramonjd, joemcgill, costdev, aaronrobertshaw, peterwilsoncc.
Fixes #61679. See #59595.

File:

• trunk/src/wp-includes/global-styles-and-settings.php (modified) (2 diffs)

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

@@ -258 +258 @@
     $tree        = WP_Theme_JSON_Resolver::resolve_theme_file_uris( $tree );
     $block_nodes = $tree->get_styles_block_nodes();
+
+    $can_use_cached = ! wp_is_development_mode( 'theme' );
+    $update_cache   = false;
+
+    if ( $can_use_cached ) {
+        // Hash the merged WP_Theme_JSON data to bust cache on settings or styles change.
+        $cache_hash = md5( wp_json_encode( $tree->get_raw_data() ) );
+        $cache_key  = 'wp_styles_for_blocks';
+        $cached     = get_transient( $cache_key );
+
+        // Reset the cached data if there is no value or if the hash has changed.
+        if ( ! is_array( $cached ) || $cached['hash'] !== $cache_hash ) {
+            $cached = array(
+                'hash'   => $cache_hash,
+                'blocks' => array(),
+            );
+
+            // Update the cache if the hash has changed.
+            $update_cache = true;
+        }
+    }
+
     foreach ( $block_nodes as $metadata ) {
-        $block_css = $tree->get_styles_for_block( $metadata );
+
+        if ( $can_use_cached ) {
+            // Use the block name as the key for cached CSS data. Otherwise, use a hash of the metadata.
+            $cache_node_key = isset( $metadata['name'] ) ? $metadata['name'] : md5( wp_json_encode( $metadata ) );
+
+            if ( isset( $cached['blocks'][ $cache_node_key ] ) ) {
+                $block_css = $cached['blocks'][ $cache_node_key ];
+            } else {
+                $block_css                           = $tree->get_styles_for_block( $metadata );
+                $cached['blocks'][ $cache_node_key ] = $block_css;
+
+                // Update the cache if the cache contents have changed.
+                $update_cache = true;
+            }
+        } else {
+            $block_css = $tree->get_styles_for_block( $metadata );
+        }
 
         if ( ! wp_should_load_separate_core_block_assets() ) {
@@ -305 +343 @@
         }
     }
+
+    if ( $update_cache ) {
+        set_transient( $cache_key, $cached );
+    }
 }