<!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>[56578] trunk: Themes: Inject `theme` attribute during serialization.</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/56578">56578</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/56578","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>Bernhard Reiter</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-09-14 08:50:43 +0000 (Thu, 14 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: Inject `theme` attribute during serialization.
Rather than using `_inject_theme_attribute_in_block_template_content` to inject the `theme` attribute into all Template Part blocks found in a given file-based Block Template, introduce a new function called `_inject_theme_attribute_in_template_part_block`, and use that as second argument to `serialize_blocks()` (introduced in <a href="https://core.trac.wordpress.org/changeset/56557">[56557]</a>) in order to inject said attribute during tree traversal for serialization.
This allows for a more modular approach that will eventually be extended to implement automatic insertion of hooked blocks.
Note that we're guarding `_build_block_template_result_from_file()` (i.e. the callsite of `_inject_theme_attribute_in_template_part_block` and previously of `_inject_theme_attribute_in_block_template_content`) against regressions through additional unit test coverage added in <a href="https://core.trac.wordpress.org/changeset/56562">[56562]</a>.
Props @gziolo.
Fixes <a href="https://core.trac.wordpress.org/ticket/59338">#59338</a>. See <a href="https://core.trac.wordpress.org/ticket/59313">#59313</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesblocktemplateutilsphp">trunk/src/wp-includes/block-template-utils.php</a></li>
<li><a href="#trunktestsphpunitdatatemplatestemplatewithtemplatepartwithexistingthemeattributehtml">trunk/tests/phpunit/data/templates/template-with-template-part-with-existing-theme-attribute.html</a></li>
<li><a href="#trunktestsphpunittestsblocktemplateutilsphp">trunk/tests/phpunit/tests/block-template-utils.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-09-14 05:51:09 UTC (rev 56577)
+++ trunk/src/wp-includes/block-template-utils.php 2023-09-14 08:50:43 UTC (rev 56578)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -514,6 +514,26 @@
</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">+ * Injects the active theme's stylesheet as a `theme` attribute
+ * into a given template part block.
+ *
+ * @since 6.4.0
+ * @access private
+ *
+ * @param array $block a parsed block.
+ * @return array Updated block.
+ */
+function _inject_theme_attribute_in_template_part_block( $block ) {
+ if (
+ 'core/template-part' === $block['blockName'] &&
+ ! isset( $block['attrs']['theme'] )
+ ) {
+ $block['attrs']['theme'] = get_stylesheet();
+ }
+ return $block;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Parses a block template and removes the theme attribute from each template part.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.9.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -565,7 +585,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $template = new WP_Block_Template();
</span><span class="cx" style="display: block; padding: 0 10px"> $template->id = $theme . '//' . $template_file['slug'];
</span><span class="cx" style="display: block; padding: 0 10px"> $template->theme = $theme;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $template->content = _inject_theme_attribute_in_block_template_content( $template_content );
</del><span class="cx" style="display: block; padding: 0 10px"> $template->slug = $template_file['slug'];
</span><span class="cx" style="display: block; padding: 0 10px"> $template->source = 'theme';
</span><span class="cx" style="display: block; padding: 0 10px"> $template->type = $template_type;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -589,6 +608,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $template->area = $template_file['area'];
</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">+ $blocks = parse_blocks( $template_content );
+ $template->content = serialize_blocks( $blocks, '_inject_theme_attribute_in_template_part_block' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $template;
</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="trunktestsphpunitdatatemplatestemplatewithtemplatepartwithexistingthemeattributehtml"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/data/templates/template-with-template-part-with-existing-theme-attribute.html</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/data/templates/template-with-template-part-with-existing-theme-attribute.html 2023-09-14 05:51:09 UTC (rev 56577)
+++ trunk/tests/phpunit/data/templates/template-with-template-part-with-existing-theme-attribute.html 2023-09-14 08:50:43 UTC (rev 56578)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1 +1 @@
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-<!-- wp:template-part {"slug":"header","theme":"fake-theme","align":"full", "tagName":"header","className":"site-header"} /-->
</del><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of file
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<!-- wp:template-part {"slug":"header","theme":"fake-theme","align":"full","tagName":"header","className":"site-header"} /-->
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of file
</span></span></pre></div>
<a id="trunktestsphpunittestsblocktemplateutilsphp"></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-utils.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/block-template-utils.php 2023-09-14 05:51:09 UTC (rev 56577)
+++ trunk/tests/phpunit/tests/block-template-utils.php 2023-09-14 08:50:43 UTC (rev 56578)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -208,7 +208,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'a template with a template part block with an existing theme attribute' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'filename' => 'template-with-template-part-with-existing-theme-attribute.html',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'expected' => '<!-- wp:template-part {"slug":"header","theme":"fake-theme","align":"full", "tagName":"header","className":"site-header"} /-->',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'expected' => '<!-- wp:template-part {"slug":"header","theme":"fake-theme","align":"full","tagName":"header","className":"site-header"} /-->',
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'a template with no template part block' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'filename' => 'template.html',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -219,6 +219,84 @@
</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 59338
+ *
+ * @covers ::test_inject_theme_attribute_in_template_part_block
+ */
+ public function test_inject_theme_attribute_in_template_part_block() {
+ $template_part_block_without_theme_attribute = array(
+ 'blockName' => 'core/template-part',
+ 'attrs' => array(
+ 'slug' => 'header',
+ 'align' => 'full',
+ 'tagName' => 'header',
+ 'className' => 'site-header',
+ ),
+ 'innerHTML' => '',
+ 'innerContent' => array(),
+ 'innerBlocks' => array(),
+ );
+
+ $actual = _inject_theme_attribute_in_template_part_block( $template_part_block_without_theme_attribute );
+ $expected = array(
+ 'blockName' => 'core/template-part',
+ 'attrs' => array(
+ 'slug' => 'header',
+ 'align' => 'full',
+ 'tagName' => 'header',
+ 'className' => 'site-header',
+ 'theme' => get_stylesheet(),
+ ),
+ 'innerHTML' => '',
+ 'innerContent' => array(),
+ 'innerBlocks' => array(),
+ );
+ $this->assertSame(
+ $expected,
+ $actual,
+ '`theme` attribute was not correctly injected in template part block.'
+ );
+
+ // Does not inject theme when there is an existing theme attribute.
+ $template_part_block_with_existing_theme_attribute = array(
+ 'blockName' => 'core/template-part',
+ 'attrs' => array(
+ 'slug' => 'header',
+ 'align' => 'full',
+ 'tagName' => 'header',
+ 'className' => 'site-header',
+ 'theme' => 'fake-theme',
+ ),
+ 'innerHTML' => '',
+ 'innerContent' => array(),
+ 'innerBlocks' => array(),
+ );
+
+ $actual = _inject_theme_attribute_in_template_part_block( $template_part_block_with_existing_theme_attribute );
+ $this->assertSame(
+ $template_part_block_with_existing_theme_attribute,
+ $actual,
+ 'Existing `theme` attribute in template part block was not respected by attribute injection.'
+ );
+
+ // Does not inject theme when there is no template part.
+ $non_template_part_block = array(
+ 'blockName' => 'core/post-content',
+ 'attrs' => array(),
+ 'innerHTML' => '',
+ 'innerContent' => array(),
+ 'innerBlocks' => array(),
+ );
+
+ $actual = _inject_theme_attribute_in_template_part_block( $non_template_part_block );
+ $this->assertSame(
+ $non_template_part_block,
+ $actual,
+ '`theme` attribute injection modified non-template-part block.'
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_inject_theme_attribute_in_block_template_content() {
</span><span class="cx" style="display: block; padding: 0 10px"> $theme = get_stylesheet();
</span><span class="cx" style="display: block; padding: 0 10px"> $content_without_theme_attribute = '<!-- wp:template-part {"slug":"header","align":"full", "tagName":"header","className":"site-header"} /-->';
</span></span></pre>
</div>
</div>
</body>
</html>