Changeset 58025 for trunk/src/wp-includes/class-wp-theme.php

Timestamp:

04/19/2024 05:57:43 PM (9 months ago)

Author:

joemcgill

Message:

Themes: Cache block theme patterns in a transient.

This extends the benefits of persistent caching added in [56978] for block theme patterns to sites that are not using a persistent object cache. By default, these caches expire using the value of the WP_Theme::cache_expiration property. The transient cache TTL can be overridden using the newly introduced wp_theme_files_cache_ttl filter.

Props thekt12, joemcgill, flixos90, peterwilsoncc, spacedmonkey.
See #59600, #59719.

File:

• trunk/src/wp-includes/class-wp-theme.php (modified) (5 diffs)

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

@@ -1973 +1973 @@
      *
      * @since 6.4.0
+     * @since 6.6.0 Uses transients to cache regardless of site environment.
      *
      * @return array|false Returns an array of patterns if cache is found, otherwise false.
@@ -1980 +1981 @@
             return false;
         }
-        $pattern_data = wp_cache_get( 'wp_theme_patterns_' . $this->stylesheet, 'theme_files' );
+
+        $pattern_data = get_site_transient( 'wp_theme_files_patterns-' . $this->cache_hash );
+
         if ( is_array( $pattern_data ) && $pattern_data['version'] === $this->get( 'Version' ) ) {
             return $pattern_data['patterns'];
@@ -1991 +1994 @@
      *
      * @since 6.4.0
+     * @since 6.6.0 Uses transients to cache regardless of site environment.
      *
      * @param array $patterns Block patterns data to set in cache.
@@ -1999 +2003 @@
             'patterns' => $patterns,
         );
-        wp_cache_set( 'wp_theme_patterns_' . $this->stylesheet, $pattern_data, 'theme_files' );
+
+        /**
+         * Filters the cache expiration time for theme files.
+         *
+         * @since 6.6.0
+         *
+         * @param int    $cache_expiration Cache expiration time in seconds.
+         * @param string $cache_type       Type of cache being set.
+         */
+        $cache_expiration = (int) apply_filters( 'wp_theme_files_cache_ttl', self::$cache_expiration, 'theme_block_patterns' );
+
+        // We don't want to cache patterns infinitely.
+        if ( $cache_expiration <= 0 ) {
+            _doing_it_wrong(
+                __METHOD__,
+                sprintf(
+                    /* translators: %1$s: The filter name.*/
+                    __( 'The %1$s filter must return an integer value greater than 0.' ),
+                    '<code>wp_theme_files_cache_ttl</code>'
+                ),
+                '6.6.0'
+            );
+
+            $cache_expiration = self::$cache_expiration;
+        }
+
+        set_site_transient( 'wp_theme_files_patterns-' . $this->cache_hash, $pattern_data, $cache_expiration );
     }
 
@@ -2006 +2036 @@
      *
      * @since 6.4.0
+     * @since 6.6.0 Uses transients to cache regardless of site environment.
      */
     public function delete_pattern_cache() {
-        wp_cache_delete( 'wp_theme_patterns_' . $this->stylesheet, 'theme_files' );
+        delete_site_transient( 'wp_theme_files_patterns-' . $this->cache_hash );
     }