<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[58025] trunk: Themes: Cache block theme patterns in a transient.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/58025">58025</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/58025","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>joemcgill</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-04-19 17:57:43 +0000 (Fri, 19 Apr 2024)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Themes: Cache block theme patterns in a transient.
This extends the benefits of persistent caching added in <a href="https://core.trac.wordpress.org/changeset/56978">[56978]</a> 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 <a href="https://core.trac.wordpress.org/ticket/59600">#59600</a>, <a href="https://core.trac.wordpress.org/ticket/59719">#59719</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpthemephp">trunk/src/wp-includes/class-wp-theme.php</a></li>
<li><a href="#trunktestsphpunitteststhemewpThemeGetBlockPatternsphp">trunk/tests/phpunit/tests/theme/wpThemeGetBlockPatterns.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpthemephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-theme.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-theme.php 2024-04-19 03:40:54 UTC (rev 58024)
+++ trunk/src/wp-includes/class-wp-theme.php 2024-04-19 17:57:43 UTC (rev 58025)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1972,6 +1972,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Gets block pattern cache.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.4.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.6.0 Uses transients to cache regardless of site environment.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array|false Returns an array of patterns if cache is found, otherwise false.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1979,7 +1980,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $this->exists() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $pattern_data = wp_cache_get( 'wp_theme_patterns_' . $this->stylesheet, 'theme_files' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $pattern_data = get_site_transient( 'wp_theme_files_patterns-' . $this->cache_hash );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_array( $pattern_data ) && $pattern_data['version'] === $this->get( 'Version' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $pattern_data['patterns'];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1990,6 +1993,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Sets block pattern cache.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.4.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.6.0 Uses transients to cache regardless of site environment.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $patterns Block patterns data to set in cache.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1998,7 +2002,33 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'version' => $this->get( 'Version' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'patterns' => $patterns,
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_cache_set( 'wp_theme_patterns_' . $this->stylesheet, $pattern_data, 'theme_files' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * 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 );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2005,9 +2035,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Clears block pattern cache.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.4.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.6.0 Uses transients to cache regardless of site environment.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function delete_pattern_cache() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_cache_delete( 'wp_theme_patterns_' . $this->stylesheet, 'theme_files' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ delete_site_transient( 'wp_theme_files_patterns-' . $this->cache_hash );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre></div>
<a id="trunktestsphpunitteststhemewpThemeGetBlockPatternsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/theme/wpThemeGetBlockPatterns.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/theme/wpThemeGetBlockPatterns.php 2024-04-19 03:40:54 UTC (rev 58024)
+++ trunk/tests/phpunit/tests/theme/wpThemeGetBlockPatterns.php 2024-04-19 17:57:43 UTC (rev 58025)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -12,7 +12,24 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers WP_Theme::get_block_patterns
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class Tests_Theme_WPThemeGetBlockPatterns extends WP_UnitTestCase {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * The initial cache object.
+ *
+ * @var object
+ */
+ private $initial_cache_object;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 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();
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public static function wpSetUpBeforeClass() {
</span><span class="cx" style="display: block; padding: 0 10px"> // Ensure development mode is reset before running these tests.
</span><span class="cx" style="display: block; padding: 0 10px"> unset( $GLOBALS['_wp_tests_development_mode'] );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -40,6 +57,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 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;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 59490
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @dataProvider data_get_block_patterns
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -196,4 +227,72 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'The cache for block theme patterns should have been cleared due to theme development mode.'
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @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.'
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>