Changeset 58025

Timestamp:

04/19/2024 05:57:43 PM (8 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.

Location:

trunk

Files:

• src/wp-includes/class-wp-theme.php (modified) (5 diffs)
• tests/phpunit/tests/theme/wpThemeGetBlockPatterns.php (modified) (3 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 );
     }
 

trunk/tests/phpunit/tests/theme/wpThemeGetBlockPatterns.php

@@ -13 +13 @@
  */
 class Tests_Theme_WPThemeGetBlockPatterns extends WP_UnitTestCase {
+    /**
+     * The initial cache object.
+     *
+     * @var object
+     */
+    private $initial_cache_object;
+
+    public function set_up() {
+        parent::set_up();
+
+        $this->initial_cache_object = wp_using_ext_object_cache();
+    }
+
+    public function tear_down() {
+        wp_using_ext_object_cache( $this->initial_cache_object );
+        parent::tear_down();
+    }
 
     public static function wpSetUpBeforeClass() {
@@ -38 +55 @@
 
         return $pattern_cache;
+    }
+
+    /**
+     * Test helper to access the private cache_hash propery of a theme.
+     *
+     * @param WP_Theme $wp_theme A WP_Theme object.
+     * @return array|false Returns an array of patterns if cache is found, otherwise false.
+     */
+    private function get_cache_hash( $wp_theme ) {
+        $reflection = new ReflectionProperty( get_class( $wp_theme ), 'cache_hash' );
+        $reflection->setAccessible( true );
+        $cache_hash = $reflection->getValue( $wp_theme );
+        $reflection->setAccessible( false );
+        return $cache_hash;
     }
 
@@ -197 +228 @@
         );
     }
+
+    /**
+     * @ticket 59600
+     *
+     * @covers WP_Theme::delete_pattern_cache
+     */
+    public function test_delete_pattern_cache_non_obj_cache() {
+        // Ensure object cache is disabled.
+        wp_using_ext_object_cache( false );
+
+        $theme = wp_get_theme( 'block-theme-patterns' );
+
+        $this->assertTrue( $theme->exists(), 'The test theme could not be found.' );
+
+        $theme->get_block_patterns();
+
+        $this->assertSameSets(
+            array(
+                'cta.php' => array(
+                    'title'       => 'Centered Call To Action',
+                    'slug'        => 'block-theme-patterns/cta',
+                    'description' => '',
+                    'categories'  => array( 'call-to-action' ),
+                ),
+            ),
+            $this->get_pattern_cache( $theme ),
+            'The cache for block theme patterns should match the expected.'
+        );
+        $theme->delete_pattern_cache();
+        $this->assertFalse(
+            $this->get_pattern_cache( $theme ),
+            'The cache for block theme patterns should have been cleared.'
+        );
+    }
+
+    /**
+     * Check if the pattern cache is stored in transient if object cache is not present.
+     *
+     * @ticket 59600
+     */
+    public function test_pattern_transient_cache_for_non_cache_site() {
+        // Ensure object cache is disabled.
+        wp_using_ext_object_cache( false );
+
+        $theme = wp_get_theme( 'block-theme-patterns' );
+        $theme->get_block_patterns();
+
+        $transient_key   = 'wp_theme_files_patterns-' . $this->get_cache_hash( $theme );
+        $transient_value = get_site_transient( $transient_key );
+
+        $this->assertSameSets(
+            array(
+                'cta.php' => array(
+                    'title'       => 'Centered Call To Action',
+                    'slug'        => 'block-theme-patterns/cta',
+                    'description' => '',
+                    'categories'  => array( 'call-to-action' ),
+                ),
+            ),
+            $transient_value['patterns'],
+            'The transient value should match the expected.'
+        );
+
+        $this->assertNotEmpty(
+            $this->get_pattern_cache( $theme ),
+            'The cache for block theme patterns is empty.'
+        );
+    }
 }