<!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>[56724] trunk: Templates: Introduce _remove_theme_attribute_from_template_part_block.</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/56724">56724</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/56724","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-26 16:59:11 +0000 (Tue, 26 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'>Templates: Introduce _remove_theme_attribute_from_template_part_block.
Introduce a `_remove_theme_attribute_from_template_part_block()` function that can be used as a callback argument for `traverse_and_serialize_block(s)` on a parsed block tree in order to remove the `theme` attribute from all Template Part blocks found therein, and deprecate `_remove_theme_attribute_in_block_template_content()`.
Counterpart to `_inject_theme_attribute_in_template_part_block` from <a href="https://core.trac.wordpress.org/ticket/59338">#59338</a> (which superseded `_inject_theme_attribute_in_block_template_content`, deprecated in <a href="https://core.trac.wordpress.org/ticket/59452">#59452</a>).
Props mukesh27.
Fixes <a href="https://core.trac.wordpress.org/ticket/59460">#59460</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesblocktemplateutilsphp">trunk/src/wp-includes/block-template-utils.php</a></li>
<li><a href="#trunksrcwpincludesdeprecatedphp">trunk/src/wp-includes/deprecated.php</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-26 16:53:20 UTC (rev 56723)
+++ trunk/src/wp-includes/block-template-utils.php 2023-09-26 16:59:11 UTC (rev 56724)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -490,36 +490,21 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Parses a block template and removes the theme attribute from each template part.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Removes the `theme` attribute from a given template part block.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 5.9.0
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.4.0
</ins><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $template_content Serialized block template content.
- * @return string Updated block template content.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $block a parsed block.
+ * @return void
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function _remove_theme_attribute_in_block_template_content( $template_content ) {
- $has_updated_content = false;
- $new_content = '';
- $template_blocks = parse_blocks( $template_content );
-
- $blocks = _flatten_blocks( $template_blocks );
- foreach ( $blocks as $key => $block ) {
- if ( 'core/template-part' === $block['blockName'] && isset( $block['attrs']['theme'] ) ) {
- unset( $blocks[ $key ]['attrs']['theme'] );
- $has_updated_content = true;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function _remove_theme_attribute_from_template_part_block( &$block ) {
+ if (
+ 'core/template-part' === $block['blockName'] &&
+ isset( $block['attrs']['theme'] )
+ ) {
+ unset( $block['attrs']['theme'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- if ( ! $has_updated_content ) {
- return $template_content;
- }
-
- foreach ( $template_blocks as $block ) {
- $new_content .= serialize_block( $block );
- }
-
- return $new_content;
</del><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">@@ -1278,7 +1263,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Load templates into the zip file.
</span><span class="cx" style="display: block; padding: 0 10px"> $templates = get_block_templates();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $templates as $template ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $template->content = _remove_theme_attribute_in_block_template_content( $template->content );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $template->content = traverse_and_serialize_blocks(
+ parse_blocks( $template->content ),
+ '_remove_theme_attribute_from_template_part_block'
+ );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $zip->addFromString(
</span><span class="cx" style="display: block; padding: 0 10px"> 'templates/' . $template->slug . '.html',
</span></span></pre></div>
<a id="trunksrcwpincludesdeprecatedphp"></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/deprecated.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/deprecated.php 2023-09-26 16:53:20 UTC (rev 56723)
+++ trunk/src/wp-includes/deprecated.php 2023-09-26 16:59:11 UTC (rev 56724)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -6084,3 +6084,43 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $template_content;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * Parses a block template and removes the theme attribute from each template part.
+ *
+ * @since 5.9.0
+ * @deprecated 6.4.0 Use traverse_and_serialize_blocks( parse_blocks( $template_content ), '_remove_theme_attribute_from_template_part_block' ) instead.
+ * @access private
+ *
+ * @param string $template_content Serialized block template content.
+ * @return string Updated block template content.
+ */
+function _remove_theme_attribute_in_block_template_content( $template_content ) {
+ _deprecated_function(
+ __FUNCTION__,
+ '6.4.0',
+ 'traverse_and_serialize_blocks( parse_blocks( $template_content ), "_remove_theme_attribute_from_template_part_block" )'
+ );
+
+ $has_updated_content = false;
+ $new_content = '';
+ $template_blocks = parse_blocks( $template_content );
+
+ $blocks = _flatten_blocks( $template_blocks );
+ foreach ( $blocks as $key => $block ) {
+ if ( 'core/template-part' === $block['blockName'] && isset( $block['attrs']['theme'] ) ) {
+ unset( $blocks[ $key ]['attrs']['theme'] );
+ $has_updated_content = true;
+ }
+ }
+
+ if ( ! $has_updated_content ) {
+ return $template_content;
+ }
+
+ foreach ( $template_blocks as $block ) {
+ $new_content .= serialize_block( $block );
+ }
+
+ return $new_content;
+}
</ins></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-26 16:53:20 UTC (rev 56723)
+++ trunk/tests/phpunit/tests/block-template-utils.php 2023-09-26 16:59:11 UTC (rev 56724)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -361,13 +361,39 @@
</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"> * @ticket 54448
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 59460
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @dataProvider data_remove_theme_attribute_in_block_template_content
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @expectedDeprecated _remove_theme_attribute_in_block_template_content
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_remove_theme_attribute_in_block_template_content( $template_content, $expected ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $expected, _remove_theme_attribute_in_block_template_content( $template_content ) );
</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 59460
+ *
+ * @covers ::_remove_theme_attribute_from_template_part_block
+ * @covers ::traverse_and_serialize_blocks
+ *
+ * @dataProvider data_remove_theme_attribute_in_block_template_content
+ *
+ * @param string $template_content The template markup.
+ * @param string $expected The expected markup after removing the theme attribute from Template Part blocks.
+ */
+ public function test_remove_theme_attribute_from_template_part_block( $template_content, $expected ) {
+ $template_content_parsed_blocks = parse_blocks( $template_content );
+
+ $this->assertSame(
+ $expected,
+ traverse_and_serialize_blocks(
+ $template_content_parsed_blocks,
+ '_remove_theme_attribute_from_template_part_block'
+ )
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function data_remove_theme_attribute_in_block_template_content() {
</span><span class="cx" style="display: block; padding: 0 10px"> return array(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span></span></pre>
</div>
</div>
</body>
</html>