<!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>[56621] trunk: Themes: Improve performance of get_block_theme_folders function</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/56621">56621</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/56621","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>spacedmonkey</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-09-19 16:15:52 +0000 (Tue, 19 Sep 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: Improve performance of get_block_theme_folders function
This commit enhances the performance of the get_block_theme_folders function by introducing a new method called get_block_template_folders within the WP_Theme class. Previously, this function suffered from poor performance due to repeated file lookups using file_exists. The new method implements basic caching, storing the result in the theme's cache, similar to how block themes are cached in the block_theme property (see <a href="https://core.trac.wordpress.org/changeset/55236">[55236]</a>).
Additionally, this change improves error handling by checking if a theme exists before attempting to look up the file. It also enhances test coverage.
Props spacedmonkey, thekt12, swissspidy, flixos90, costdev, mukesh27.
Fixes <a href="https://core.trac.wordpress.org/ticket/58319">#58319</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesblocktemplateutilsphp">trunk/src/wp-includes/block-template-utils.php</a></li>
<li><a href="#trunksrcwpincludesclasswpthemephp">trunk/src/wp-includes/class-wp-theme.php</a></li>
<li><a href="#trunktestsphpunittestsblocktemplatephp">trunk/tests/phpunit/tests/block-template.php</a></li>
<li><a href="#trunktestsphpunitteststhemethemeDirphp">trunk/tests/phpunit/tests/theme/themeDir.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li>trunk/tests/phpunit/data/themedir1/block-theme-child-deprecated-path/</li>
<li>trunk/tests/phpunit/data/themedir1/block-theme-child-deprecated-path/block-template-parts/</li>
<li><a href="#trunktestsphpunitdatathemedir1blockthemechilddeprecatedpathblocktemplatepartssmallheaderhtml">trunk/tests/phpunit/data/themedir1/block-theme-child-deprecated-path/block-template-parts/small-header.html</a></li>
<li><a href="#trunktestsphpunitdatathemedir1blockthemechilddeprecatedpathstylecss">trunk/tests/phpunit/data/themedir1/block-theme-child-deprecated-path/style.css</a></li>
<li>trunk/tests/phpunit/data/themedir1/block-theme-child-deprecated-path/templates/</li>
<li><a href="#trunktestsphpunitdatathemedir1blockthemechilddeprecatedpathtemplatesindexhtml">trunk/tests/phpunit/data/themedir1/block-theme-child-deprecated-path/templates/index.html</a></li>
<li><a href="#trunktestsphpunitdatathemedir1blockthemechilddeprecatedpaththemejson">trunk/tests/phpunit/data/themedir1/block-theme-child-deprecated-path/theme.json</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesblocktemplateutilsphp"></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-template-utils.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/block-template-utils.php 2023-09-19 12:48:41 UTC (rev 56620)
+++ trunk/src/wp-includes/block-template-utils.php 2023-09-19 16:15:52 UTC (rev 56621)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -37,21 +37,15 @@
</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"> function get_block_theme_folders( $theme_stylesheet = null ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $theme_name = null === $theme_stylesheet ? get_stylesheet() : $theme_stylesheet;
- $root_dir = get_theme_root( $theme_name );
- $theme_dir = "$root_dir/$theme_name";
-
- if ( file_exists( $theme_dir . '/block-templates' ) || file_exists( $theme_dir . '/block-template-parts' ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $theme = wp_get_theme( (string) $theme_stylesheet );
+ if ( ! $theme->exists() ) {
+ // Return the default folders if the theme doesn't exist.
</ins><span class="cx" style="display: block; padding: 0 10px"> return array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'wp_template' => 'block-templates',
- 'wp_template_part' => 'block-template-parts',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'wp_template' => 'templates',
+ 'wp_template_part' => 'parts',
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- return array(
- 'wp_template' => 'templates',
- 'wp_template_part' => 'parts',
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return $theme->get_block_template_folders();
</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="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 2023-09-19 12:48:41 UTC (rev 56620)
+++ trunk/src/wp-includes/class-wp-theme.php 2023-09-19 16:15:52 UTC (rev 56621)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -195,6 +195,25 @@
</span><span class="cx" style="display: block; padding: 0 10px"> private $cache_hash;
</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">+ * Block template folders.
+ *
+ * @since 6.4.0
+ * @var string[]
+ */
+ private $block_template_folders;
+
+ /**
+ * Default values for template folders.
+ *
+ * @since 6.4.0
+ * @var string[]
+ */
+ private $default_template_folders = array(
+ 'wp_template' => 'templates',
+ 'wp_template_part' => 'parts',
+ );
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Flag for whether the themes cache bucket should be persistently cached.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Default is false. Can be set with the {@see 'wp_cache_themes_persistently'} filter.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -262,7 +281,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $cache = $this->cache_get( 'theme' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_array( $cache ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( array( 'block_theme', 'errors', 'headers', 'template' ) as $key ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( array( 'block_template_folders', 'block_theme', 'errors', 'headers', 'template' ) as $key ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $cache[ $key ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->$key = $cache[ $key ];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -287,16 +306,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->errors = new WP_Error( 'theme_no_stylesheet', __( 'Stylesheet is missing.' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->template = $this->stylesheet;
- $this->block_theme = false;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->template = $this->stylesheet;
+ $this->block_theme = false;
+ $this->block_template_folders = $this->default_template_folders;
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->cache_add(
</span><span class="cx" style="display: block; padding: 0 10px"> 'theme',
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'block_theme' => $this->block_theme,
- 'headers' => $this->headers,
- 'errors' => $this->errors,
- 'stylesheet' => $this->stylesheet,
- 'template' => $this->template,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'block_template_folders' => $this->block_template_folders,
+ 'block_theme' => $this->block_theme,
+ 'headers' => $this->headers,
+ 'errors' => $this->errors,
+ 'stylesheet' => $this->stylesheet,
+ 'template' => $this->template,
</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"> if ( ! file_exists( $this->theme_root ) ) { // Don't cache this one.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -304,18 +325,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( ! is_readable( $this->theme_root . '/' . $theme_file ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->headers['Name'] = $this->stylesheet;
- $this->errors = new WP_Error( 'theme_stylesheet_not_readable', __( 'Stylesheet is not readable.' ) );
- $this->template = $this->stylesheet;
- $this->block_theme = false;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->headers['Name'] = $this->stylesheet;
+ $this->errors = new WP_Error( 'theme_stylesheet_not_readable', __( 'Stylesheet is not readable.' ) );
+ $this->template = $this->stylesheet;
+ $this->block_theme = false;
+ $this->block_template_folders = $this->default_template_folders;
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->cache_add(
</span><span class="cx" style="display: block; padding: 0 10px"> 'theme',
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'block_theme' => $this->block_theme,
- 'headers' => $this->headers,
- 'errors' => $this->errors,
- 'stylesheet' => $this->stylesheet,
- 'template' => $this->template,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'block_template_folders' => $this->block_template_folders,
+ 'block_theme' => $this->block_theme,
+ 'headers' => $this->headers,
+ 'errors' => $this->errors,
+ 'stylesheet' => $this->stylesheet,
+ 'template' => $this->template,
</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"> return;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -345,10 +368,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->cache_add(
</span><span class="cx" style="display: block; padding: 0 10px"> 'theme',
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'block_theme' => $this->is_block_theme(),
- 'headers' => $this->headers,
- 'errors' => $this->errors,
- 'stylesheet' => $this->stylesheet,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'block_template_folders' => $this->get_block_template_folders(),
+ 'block_theme' => $this->is_block_theme(),
+ 'headers' => $this->headers,
+ 'errors' => $this->errors,
+ 'stylesheet' => $this->stylesheet,
</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">@@ -378,11 +402,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->cache_add(
</span><span class="cx" style="display: block; padding: 0 10px"> 'theme',
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'block_theme' => $this->block_theme,
- 'headers' => $this->headers,
- 'errors' => $this->errors,
- 'stylesheet' => $this->stylesheet,
- 'template' => $this->template,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'block_template_folders' => $this->get_block_template_folders(),
+ 'block_theme' => $this->block_theme,
+ 'headers' => $this->headers,
+ 'errors' => $this->errors,
+ 'stylesheet' => $this->stylesheet,
+ 'template' => $this->template,
</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"> return;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -419,11 +444,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->cache_add(
</span><span class="cx" style="display: block; padding: 0 10px"> 'theme',
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'block_theme' => $this->is_block_theme(),
- 'headers' => $this->headers,
- 'errors' => $this->errors,
- 'stylesheet' => $this->stylesheet,
- 'template' => $this->template,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'block_template_folders' => $this->get_block_template_folders(),
+ 'block_theme' => $this->is_block_theme(),
+ 'headers' => $this->headers,
+ 'errors' => $this->errors,
+ 'stylesheet' => $this->stylesheet,
+ 'template' => $this->template,
</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"> $this->parent = new WP_Theme( $this->template, $this->theme_root, $this );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -447,11 +473,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $_child->cache_add(
</span><span class="cx" style="display: block; padding: 0 10px"> 'theme',
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'block_theme' => $_child->is_block_theme(),
- 'headers' => $_child->headers,
- 'errors' => $_child->errors,
- 'stylesheet' => $_child->stylesheet,
- 'template' => $_child->template,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'block_template_folders' => $_child->get_block_template_folders(),
+ 'block_theme' => $_child->is_block_theme(),
+ 'headers' => $_child->headers,
+ 'errors' => $_child->errors,
+ 'stylesheet' => $_child->stylesheet,
+ 'template' => $_child->template,
</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"> // The two themes actually reference each other with the Template header.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -467,11 +494,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->cache_add(
</span><span class="cx" style="display: block; padding: 0 10px"> 'theme',
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'block_theme' => $this->is_block_theme(),
- 'headers' => $this->headers,
- 'errors' => $this->errors,
- 'stylesheet' => $this->stylesheet,
- 'template' => $this->template,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'block_template_folders' => $this->get_block_template_folders(),
+ 'block_theme' => $this->is_block_theme(),
+ 'headers' => $this->headers,
+ 'errors' => $this->errors,
+ 'stylesheet' => $this->stylesheet,
+ 'template' => $this->template,
</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">@@ -488,11 +516,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // We're good. If we didn't retrieve from cache, set it.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_array( $cache ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $cache = array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'block_theme' => $this->is_block_theme(),
- 'headers' => $this->headers,
- 'errors' => $this->errors,
- 'stylesheet' => $this->stylesheet,
- 'template' => $this->template,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'block_theme' => $this->is_block_theme(),
+ 'block_template_folders' => $this->get_block_template_folders(),
+ 'headers' => $this->headers,
+ 'errors' => $this->errors,
+ 'stylesheet' => $this->stylesheet,
+ 'template' => $this->template,
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> // If the parent theme is in another root, we'll want to cache this. Avoids an entire branch of filesystem calls above.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $theme_root_template ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -779,15 +808,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( array( 'theme', 'screenshot', 'headers', 'post_templates' ) as $key ) {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cache_delete( $key . '-' . $this->cache_hash, 'themes' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->template = null;
- $this->textdomain_loaded = null;
- $this->theme_root_uri = null;
- $this->parent = null;
- $this->errors = null;
- $this->headers_sanitized = null;
- $this->name_translated = null;
- $this->block_theme = null;
- $this->headers = array();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->template = null;
+ $this->textdomain_loaded = null;
+ $this->theme_root_uri = null;
+ $this->parent = null;
+ $this->errors = null;
+ $this->headers_sanitized = null;
+ $this->name_translated = null;
+ $this->block_theme = null;
+ $this->block_template_folders = null;
+ $this->headers = array();
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->__construct( $this->stylesheet, $this->theme_root );
</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">@@ -1715,6 +1745,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">+ * Returns the folder names of the block template directories.
+ *
+ * @since 6.4.0
+ *
+ * @return string[] {
+ * Folder names used by block themes.
+ *
+ * @type string $wp_template Theme-relative directory name for block templates.
+ * @type string $wp_template_part Theme-relative directory name for block template parts.
+ * }
+ */
+ public function get_block_template_folders() {
+ // Return set/cached value if available.
+ if ( isset( $this->block_template_folders ) ) {
+ return $this->block_template_folders;
+ }
+
+ $this->block_template_folders = $this->default_template_folders;
+
+ $stylesheet_directory = $this->get_stylesheet_directory();
+ // If the theme uses deprecated block template folders.
+ if ( file_exists( $stylesheet_directory . '/block-templates' ) || file_exists( $stylesheet_directory . '/block-template-parts' ) ) {
+ $this->block_template_folders = array(
+ 'wp_template' => 'block-templates',
+ 'wp_template_part' => 'block-template-parts',
+ );
+ }
+ return $this->block_template_folders;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Enables a theme for all sites on the current network.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.6.0
</span></span></pre></div>
<a id="trunktestsphpunitdatathemedir1blockthemechilddeprecatedpathblocktemplatepartssmallheaderhtml"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/data/themedir1/block-theme-child-deprecated-path/block-template-parts/small-header.html</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/data/themedir1/block-theme-child-deprecated-path/block-template-parts/small-header.html (rev 0)
+++ trunk/tests/phpunit/data/themedir1/block-theme-child-deprecated-path/block-template-parts/small-header.html 2023-09-19 16:15:52 UTC (rev 56621)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,3 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<!-- wp:paragraph -->
+<p>Small Header Template Part</p>
+<!-- /wp:paragraph -->
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of file
</span><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/data/themedir1/block-theme-child-deprecated-path/block-template-parts/small-header.html
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunktestsphpunitdatathemedir1blockthemechilddeprecatedpathstylecss"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/data/themedir1/block-theme-child-deprecated-path/style.css</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/data/themedir1/block-theme-child-deprecated-path/style.css (rev 0)
+++ trunk/tests/phpunit/data/themedir1/block-theme-child-deprecated-path/style.css 2023-09-19 16:15:52 UTC (rev 56621)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,8 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/*
+Theme Name: Block Theme Child Deprecated Path
+Theme URI: https://wordpress.org/
+Description: For testing purposes only.
+Template: block-theme
+Version: 1.0.0
+Text Domain: block-theme-child-deprecated-path
+*/
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/data/themedir1/block-theme-child-deprecated-path/style.css
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunktestsphpunitdatathemedir1blockthemechilddeprecatedpathtemplatesindexhtml"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/data/themedir1/block-theme-child-deprecated-path/templates/index.html</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/data/themedir1/block-theme-child-deprecated-path/templates/index.html (rev 0)
+++ trunk/tests/phpunit/data/themedir1/block-theme-child-deprecated-path/templates/index.html 2023-09-19 16:15:52 UTC (rev 56621)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,3 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<!-- wp:paragraph -->
+<p>Index Template</p>
+<!-- /wp:paragraph -->
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of file
</span><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/data/themedir1/block-theme-child-deprecated-path/templates/index.html
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunktestsphpunitdatathemedir1blockthemechilddeprecatedpaththemejson"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/data/themedir1/block-theme-child-deprecated-path/theme.json</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/data/themedir1/block-theme-child-deprecated-path/theme.json (rev 0)
+++ trunk/tests/phpunit/data/themedir1/block-theme-child-deprecated-path/theme.json 2023-09-19 16:15:52 UTC (rev 56621)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,71 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+{
+ "version": 1,
+ "settings": {
+ "color": {
+ "palette": [
+ {
+ "slug": "light",
+ "name": "Light",
+ "color": "#f5f7f9"
+ },
+ {
+ "slug": "dark",
+ "name": "Dark",
+ "color": "#000"
+ }
+ ],
+ "gradients": [
+ {
+ "name": "Custom gradient",
+ "gradient": "linear-gradient(135deg,rgba(0,0,0) 0%,rgb(0,0,0) 100%)",
+ "slug": "custom-gradient"
+ }
+ ],
+ "custom": false,
+ "customGradient": false
+ },
+ "typography": {
+ "fontSizes": [
+ {
+ "name": "Custom",
+ "slug": "custom",
+ "size": "100px"
+ }
+ ],
+ "customFontSize": false,
+ "customLineHeight": true
+ },
+ "spacing": {
+ "units": [
+ "rem"
+ ],
+ "customPadding": true
+ },
+ "blocks": {
+ "core/paragraph": {
+ "color": {
+ "palette": [
+ {
+ "slug": "light",
+ "name": "Light",
+ "color": "#f5f7f9"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "customTemplates": [
+ {
+ "name": "page-home",
+ "title": "Homepage template"
+ }
+ ],
+ "templateParts": [
+ {
+ "name": "small-header",
+ "title": "Small Header",
+ "area": "header"
+ }
+ ]
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/data/themedir1/block-theme-child-deprecated-path/theme.json
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunktestsphpunittestsblocktemplatephp"></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/block-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/block-template.php 2023-09-19 12:48:41 UTC (rev 56620)
+++ trunk/tests/phpunit/tests/block-template.php 2023-09-19 16:15:52 UTC (rev 56621)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -276,6 +276,82 @@
</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">+ * @ticket 58319
+ *
+ * @covers ::get_block_theme_folders
+ *
+ * @dataProvider data_get_block_theme_folders
+ *
+ * @param string $theme The theme's stylesheet.
+ * @param string[] $expected The expected associative array of block theme folders.
+ */
+ public function test_get_block_theme_folders( $theme, $expected ) {
+ $wp_theme = wp_get_theme( $theme );
+ $wp_theme->cache_delete(); // Clear cache.
+
+ $this->assertSame( $expected, get_block_theme_folders( $theme ), 'Incorrect block theme folders were retrieved.' );
+ $reflection = new ReflectionMethod( $wp_theme, 'cache_get' );
+ $reflection->setAccessible( true );
+ $theme_cache = $reflection->invoke( $wp_theme, 'theme' );
+ $cached_value = $theme_cache['block_template_folders'];
+ $reflection->setAccessible( false );
+
+ $this->assertSame( $expected, $cached_value, 'The cached value is incorrect.' );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array[]
+ */
+ public function data_get_block_theme_folders() {
+ return array(
+ 'block-theme' => array(
+ 'block-theme',
+ array(
+ 'wp_template' => 'templates',
+ 'wp_template_part' => 'parts',
+ ),
+ ),
+ 'block-theme-deprecated-path' => array(
+ 'block-theme-deprecated-path',
+ array(
+ 'wp_template' => 'block-templates',
+ 'wp_template_part' => 'block-template-parts',
+ ),
+ ),
+ 'block-theme-child' => array(
+ 'block-theme-child',
+ array(
+ 'wp_template' => 'templates',
+ 'wp_template_part' => 'parts',
+ ),
+ ),
+ 'block-theme-child-deprecated-path' => array(
+ 'block-theme-child-deprecated-path',
+ array(
+ 'wp_template' => 'block-templates',
+ 'wp_template_part' => 'block-template-parts',
+ ),
+ ),
+ 'this-is-an-invalid-theme' => array(
+ 'this-is-an-invalid-theme',
+ array(
+ 'wp_template' => 'templates',
+ 'wp_template_part' => 'parts',
+ ),
+ ),
+ 'null' => array(
+ null,
+ array(
+ 'wp_template' => 'templates',
+ 'wp_template_part' => 'parts',
+ ),
+ ),
+ );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Registers a test block to log `in_the_loop()` results.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $in_the_loop_logs Array to log function results in. Passed by reference.
</span></span></pre></div>
<a id="trunktestsphpunitteststhemethemeDirphp"></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/themeDir.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/theme/themeDir.php 2023-09-19 12:48:41 UTC (rev 56620)
+++ trunk/tests/phpunit/tests/theme/themeDir.php 2023-09-19 16:15:52 UTC (rev 56621)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -176,6 +176,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'REST Theme',
</span><span class="cx" style="display: block; padding: 0 10px"> 'Block Theme',
</span><span class="cx" style="display: block; padding: 0 10px"> 'Block Theme Child Theme',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'Block Theme Child Deprecated Path',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'Block Theme Child with no theme.json',
</span><span class="cx" style="display: block; padding: 0 10px"> 'Block Theme Child Theme With Fluid Layout',
</span><span class="cx" style="display: block; padding: 0 10px"> 'Block Theme Child Theme With Fluid Typography',
</span></span></pre>
</div>
</div>
</body>
</html>