<!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>[56931] trunk: Themes: Clear existing pattern cache when in theme development mode and prevent PHP warning due to missing file.</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/56931">56931</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/56931","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>flixos90</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-10-13 16:44:09 +0000 (Fri, 13 Oct 2023)</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: Clear existing pattern cache when in theme development mode and prevent PHP warning due to missing file.
Follow up to <a href="https://core.trac.wordpress.org/changeset/56765">[56765]</a>.
Props spacedmonkey, afercia, jrf, flixos90.
Fixes <a href="https://core.trac.wordpress.org/ticket/59591">#59591</a>.
See <a href="https://core.trac.wordpress.org/ticket/59490">#59490</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesblockpatternsphp">trunk/src/wp-includes/block-patterns.php</a></li>
<li><a href="#trunktestsphpunittestsblockswpGetBlockPatternsphp">trunk/tests/phpunit/tests/blocks/wpGetBlockPatterns.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesblockpatternsphp"></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/block-patterns.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/block-patterns.php 2023-10-13 12:32:28 UTC (rev 56930)
+++ trunk/src/wp-includes/block-patterns.php 2023-10-13 16:44:09 UTC (rev 56931)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -350,9 +350,25 @@
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</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">+ $file_path = $dirpath . $file;
+
+ if ( ! file_exists( $file_path ) ) {
+ _doing_it_wrong(
+ __FUNCTION__,
+ sprintf(
+ /* translators: %s: file name. */
+ __( 'Could not register file "%s" as a block pattern as the file does not exist.' ),
+ $file
+ ),
+ '6.4.0'
+ );
+ $theme->delete_pattern_cache();
+ continue;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // The actual pattern content is the output of the file.
</span><span class="cx" style="display: block; padding: 0 10px"> ob_start();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- include $dirpath . $file;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ include $file_path;
</ins><span class="cx" style="display: block; padding: 0 10px"> $pattern_data['content'] = ob_get_clean();
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $pattern_data['content'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -408,11 +424,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function _wp_get_block_patterns( WP_Theme $theme ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $can_use_cached = ! wp_is_development_mode( 'theme' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $can_use_cached ) {
- $pattern_data = $theme->get_pattern_cache();
- if ( is_array( $pattern_data ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $pattern_data = $theme->get_pattern_cache();
+ if ( is_array( $pattern_data ) ) {
+ if ( $can_use_cached ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return $pattern_data;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If in development mode, clear pattern cache.
+ $theme->delete_pattern_cache();
</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"> $dirpath = $theme->get_stylesheet_directory() . '/patterns/';
</span></span></pre></div>
<a id="trunktestsphpunittestsblockswpGetBlockPatternsphp"></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/blocks/wpGetBlockPatterns.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/blocks/wpGetBlockPatterns.php 2023-10-13 12:32:28 UTC (rev 56930)
+++ trunk/tests/phpunit/tests/blocks/wpGetBlockPatterns.php 2023-10-13 16:44:09 UTC (rev 56931)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -18,7 +18,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $theme The theme's slug.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $expected The expected pattern data.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_should_return_block_patterns( $theme, $expected ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $patterns = _wp_get_block_patterns( wp_get_theme( $theme ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -118,4 +117,37 @@
</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">+
+ /**
+ * Tests that _wp_get_block_patterns() clears existing transient when in theme development mode.
+ *
+ * @ticket 59591
+ */
+ public function test_should_clear_existing_transient_when_in_development_mode() {
+ $theme = wp_get_theme( 'block-theme-patterns' );
+
+ // Calling the function should set the cache.
+ _wp_get_block_patterns( $theme );
+ $this->assertSameSets(
+ array(
+ 'cta.php' => array(
+ 'title' => 'Centered Call To Action',
+ 'slug' => 'block-theme-patterns/cta',
+ 'description' => '',
+ 'categories' => array( 'call-to-action' ),
+ ),
+ ),
+ $theme->get_pattern_cache(),
+ 'The transient for block theme patterns should be set'
+ );
+
+ // Calling the function while in theme development mode should clear the cache.
+ $GLOBALS['_wp_tests_development_mode'] = 'theme';
+ _wp_get_block_patterns( $theme );
+ unset( $GLOBALS['_wp_tests_development_mode'] ); // Reset to not pollute other tests.
+ $this->assertFalse(
+ $theme->get_pattern_cache(),
+ 'The transient for block theme patterns should have been cleared due to theme development mode'
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>