<!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>[52308] trunk: Editor: Allow child theme PHP templates to take precedence over parent theme block templates.</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/52308">52308</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/52308","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>audrasjb</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-12-02 23:35:20 +0000 (Thu, 02 Dec 2021)</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'>Editor: Allow child theme PHP templates to take precedence over parent theme block templates.
This change fixes template resolution to give precedence to child theme PHP templates over parent theme block templates with equal specificity.
Before this change, when a theme was using a PHP template of a certain specificity (e.g. `page-home.php`), and it happened to be a child theme of another theme which had a block template for the same specificity (e.g. `page-home.html`), WordPress was picking the parent theme's block template over the child theme's PHP template to render the page. If the PHP and block template have equal specificity, the child theme's template should be used.
The issue was fixed before in Gutenberg so the fix now needs to happen in Core.
This change also re-enables the preexisting template resolution unit tests.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/51003">[51003]</a>.
Props bernhard-reiter, youknowriad.
Fixes <a href="https://core.trac.wordpress.org/ticket/54515">#54515</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesblocktemplatephp">trunk/src/wp-includes/block-template.php</a></li>
<li><a href="#trunktestsphpunittestsblocktemplatephp">trunk/tests/phpunit/tests/block-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesblocktemplatephp"></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.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/block-template.php 2021-12-02 20:43:09 UTC (rev 52307)
+++ trunk/src/wp-includes/block-template.php 2021-12-02 23:35:20 UTC (rev 52308)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -45,7 +45,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $templates = array_slice( $templates, 0, $index + 1 );
</span><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">- $block_template = resolve_block_template( $type, $templates );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $block_template = resolve_block_template( $type, $templates, $template );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $block_template ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $block_template->content ) && is_user_logged_in() ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -92,12 +92,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.8.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.9.0 Added the `$fallback_template` parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $template_type The current template type.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string[] $template_hierarchy The current template hierarchy, ordered by priority.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $fallback_template A PHP fallback template to use if no matching block template is found.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return WP_Block_Template|null template A template object, or null if none could be found.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function resolve_block_template( $template_type, $template_hierarchy ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function resolve_block_template( $template_type, $template_hierarchy, $fallback_template ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! $template_type ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return null;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -129,6 +131,43 @@
</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">+ $theme_base_path = get_stylesheet_directory() . DIRECTORY_SEPARATOR;
+ $parent_theme_base_path = get_template_directory() . DIRECTORY_SEPARATOR;
+
+ // Is the current theme a child theme, and is the PHP fallback template part of it?
+ if (
+ strpos( $fallback_template, $theme_base_path ) === 0 &&
+ strpos( $fallback_template, $parent_theme_base_path ) === false
+ ) {
+ $fallback_template_slug = substr(
+ $fallback_template,
+ // Starting position of slug.
+ strpos( $fallback_template, $theme_base_path ) + strlen( $theme_base_path ),
+ // Remove '.php' suffix.
+ -4
+ );
+
+ // Is our candidate block template's slug identical to our PHP fallback template's?
+ if (
+ count( $templates ) &&
+ $fallback_template_slug === $templates[0]->slug &&
+ 'theme' === $templates[0]->source
+ ) {
+ // Unfortunately, we cannot trust $templates[0]->theme, since it will always
+ // be set to the current theme's slug by _build_block_template_result_from_file(),
+ // even if the block template is really coming from the current theme's parent.
+ // (The reason for this is that we want it to be associated with the current theme
+ // -- not its parent -- once we edit it and store it to the DB as a wp_template CPT.)
+ // Instead, we use _get_block_template_file() to locate the block template file.
+ $template_file = _get_block_template_file( 'wp_template', $fallback_template_slug );
+ if ( $template_file && get_template() === $template_file['theme'] ) {
+ // The block template is part of the parent theme, so we
+ // have to give precedence to the child theme's PHP template.
+ array_shift( $templates );
+ }
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return count( $templates ) ? $templates[0] : null;
</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="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 2021-12-02 20:43:09 UTC (rev 52307)
+++ trunk/tests/phpunit/tests/block-template.php 2021-12-02 23:35:20 UTC (rev 52308)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -89,16 +89,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * otherwise equal specificity.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Covers https://github.com/WordPress/gutenberg/pull/31123.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Covers https://core.trac.wordpress.org/ticket/54515.
</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"> function test_child_theme_php_template_takes_precedence_over_equally_specific_parent_theme_block_template() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /**
- * @todo This test is currently marked as skipped, since it wouldn't pass. Turns out that in Gutenberg,
- * it only passed due to a erroneous test setup.
- * For details, see https://github.com/WordPress/wordpress-develop/pull/1920#issuecomment-975929818.
- */
- $this->markTestSkipped( 'The block template resolution algorithm needs fixing in order for this test to pass.' );
-
</del><span class="cx" style="display: block; padding: 0 10px"> switch_theme( 'block-theme-child' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $page_slug_template = 'page-home.php';
</span></span></pre>
</div>
</div>
</body>
</html>