<!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>[55194] trunk: Editor: Remove need for template prefix in get_template_hierarchy.</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/55194">55194</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/55194","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>jorgefilipecosta</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-02-02 19:36:29 +0000 (Thu, 02 Feb 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'>Editor: Remove need for template prefix in get_template_hierarchy.
This commit removes the need to pass a template prefix in get_template_hierarchy.
This is required because, in some block editor usages, the template prefix is not known.
Props youknowriad, davidbaumwald, jorgefilipecosta.
Fixes <a href="https://core.trac.wordpress.org/ticket/57614">#57614</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesblocktemplateutilsphp">trunk/src/wp-includes/block-template-utils.php</a></li>
<li><a href="#trunktestsphpunittestsblocktemplatesgetTemplateHierarchyphp">trunk/tests/phpunit/tests/block-templates/getTemplateHierarchy.php</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-02-02 18:57:39 UTC (rev 55193)
+++ trunk/src/wp-includes/block-template-utils.php 2023-02-02 19:36:29 UTC (rev 55194)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1325,12 +1325,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return array( 'front-page', 'home', 'index' );
</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">+ $matches = array();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $template_hierarchy = array( $slug );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> // Most default templates don't have `$template_prefix` assigned.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $template_prefix ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $template_prefix ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> list( $type ) = explode( '-', $template_prefix );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // These checks are needed because the `$slug` above is always added.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // We need these checks because we always add the `$slug` above.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! in_array( $template_prefix, array( $slug, $type ), true ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $template_hierarchy[] = $template_prefix;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1337,8 +1338,33 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $slug !== $type ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $template_hierarchy[] = $type;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } else if ( preg_match( '/^(author|category|archive|tag|page)-.+$/', $slug, $matches ) ) {
+ $template_hierarchy[] = $matches[1];
+ } else if ( preg_match( '/^(taxonomy|single)-(.+)$/', $slug, $matches ) ) {
+ $type = $matches[1];
+ $slug_remaining = $matches[2];
+
+ $items = 'single' === $type ? get_post_types() : get_taxonomies();
+ foreach ( $items as $item ) {
+ if ( ! str_starts_with( $slug_remaining, $item ) ) {
+ continue;
+ }
+
+ // If $slug_remaining is equal to $post_type or $taxonomy we have
+ // the single-$post_type template or the taxonomy-$taxonomy template.
+ if ( $slug_remaining === $item ) {
+ $template_hierarchy[] = $type;
+ break;
+ }
+
+ // If $slug_remaining is single-$post_type-$slug template.
+ if ( strlen( $slug_remaining ) > strlen( $item ) + 1 ) {
+ $template_hierarchy[] = "$type-$item";
+ $template_hierarchy[] = $type;
+ break;
+ }
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> // Handle `archive` template.
</span><span class="cx" style="display: block; padding: 0 10px"> if (
</span><span class="cx" style="display: block; padding: 0 10px"> str_starts_with( $slug, 'author' ) ||
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1353,7 +1379,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'attachment' === $slug ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $template_hierarchy[] = 'single';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> // Handle `singular` template.
</span><span class="cx" style="display: block; padding: 0 10px"> if (
</span><span class="cx" style="display: block; padding: 0 10px"> str_starts_with( $slug, 'single' ) ||
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1362,8 +1387,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $template_hierarchy[] = 'singular';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> $template_hierarchy[] = 'index';
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> return $template_hierarchy;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsblocktemplatesgetTemplateHierarchyphp"></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-templates/getTemplateHierarchy.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/block-templates/getTemplateHierarchy.php 2023-02-02 18:57:39 UTC (rev 55193)
+++ trunk/tests/phpunit/tests/block-templates/getTemplateHierarchy.php 2023-02-02 19:36:29 UTC (rev 55194)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -8,6 +8,26 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class Tests_Block_Templates_GetTemplate_Hierarchy extends WP_Block_Templates_UnitTestCase {
</span><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();
+ register_post_type(
+ 'custom_book',
+ array(
+ 'public' => true,
+ 'show_in_rest' => true,
+ )
+ );
+ register_taxonomy( 'book_type', 'custom_book' );
+ register_taxonomy( 'books', 'custom_book' );
+ }
+
+ public function tear_down() {
+ unregister_post_type( 'custom_book' );
+ unregister_taxonomy( 'book_type' );
+ unregister_taxonomy( 'books' );
+ parent::tear_down();
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @dataProvider data_get_template_hierarchy
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -83,14 +103,26 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'args' => array( 'category-fruits', false, 'category' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => array( 'category-fruits', 'category', 'archive', 'index' ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'single word categories no prefix' => array(
+ 'args' => array( 'category-fruits', false ),
+ 'expected' => array( 'category-fruits', 'category', 'archive', 'index' ),
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'multi word categories' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'args' => array( 'category-fruits-yellow', false, 'category' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => array( 'category-fruits-yellow', 'category', 'archive', 'index' ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'multi word categories no prefix' => array(
+ 'args' => array( 'category-fruits-yellow', false ),
+ 'expected' => array( 'category-fruits-yellow', 'category', 'archive', 'index' ),
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'single word taxonomy and term' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'args' => array( 'taxonomy-books-action', false, 'taxonomy-books' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => array( 'taxonomy-books-action', 'taxonomy-books', 'taxonomy', 'archive', 'index' ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'single word taxonomy and term no prefix' => array(
+ 'args' => array( 'taxonomy-books-action', false ),
+ 'expected' => array( 'taxonomy-books-action', 'taxonomy-books', 'taxonomy', 'archive', 'index' ),
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'single word taxonomy and multi word term' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'args' => array( 'taxonomy-books-action-adventure', false, 'taxonomy-books' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => array( 'taxonomy-books-action-adventure', 'taxonomy-books', 'taxonomy', 'archive', 'index' ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -119,6 +151,46 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'args' => array( 'author-rigas', false, 'author' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => array( 'author-rigas', 'author', 'archive', 'index' ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'multiple word taxonomy no prefix' => array(
+ 'args' => array( 'taxonomy-book_type-adventure', false ),
+ 'expected' => array( 'taxonomy-book_type-adventure', 'taxonomy-book_type', 'taxonomy', 'archive', 'index' ),
+ ),
+ 'single post type no prefix' => array(
+ 'args' => array( 'single-custom_book', false ),
+ 'expected' => array(
+ 'single-custom_book',
+ 'single',
+ 'singular',
+ 'index',
+ ),
+ ),
+ 'single post and post type no prefix' => array(
+ 'args' => array( 'single-custom_book-book-1', false ),
+ 'expected' => array(
+ 'single-custom_book-book-1',
+ 'single-custom_book',
+ 'single',
+ 'singular',
+ 'index',
+ ),
+ ),
+ 'page no prefix' => array(
+ 'args' => array( 'page-hi', false ),
+ 'expected' => array(
+ 'page-hi',
+ 'page',
+ 'singular',
+ 'index',
+ ),
+ ),
+ 'post type archive no prefix' => array(
+ 'args' => array( 'archive-book', false ),
+ 'expected' => array(
+ 'archive-book',
+ 'archive',
+ 'index',
+ ),
+ ),
</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>
</div>
</body>
</html>