<!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>[51382] branches/5.8: Posts: Prevent an empty excerpt when groups and nested column blocks are present.</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/51382">51382</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/51382","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>jorbin</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-07-08 17:27:27 +0000 (Thu, 08 Jul 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'>Posts: Prevent an empty excerpt when groups and nested column blocks are present.
This improves the logic within excerpt_remove_blocks() to better handle innerBlocks. This prevents an empty excerpt from being returned when core/columns, core/column, and core/group blocks are present.
This issue has been surfaced in the Query Loop block, where excerpts can be set to display.
This introduces the excerpt_allowed_wrapper_blocks filter for controlling which blocks should be considered wrapper blocks.
Wrapper blocks and their nested contents are not stripped by excerpt_remove_blocks(), allowing their contents to appear in generated excerpts.
Backports <a href="https://core.trac.wordpress.org/changeset/51348">[51348]</a>, <a href="https://core.trac.wordpress.org/changeset/51375">[51375]</a>, <a href="https://core.trac.wordpress.org/changeset/51378">[51378]</a>, and <a href="https://core.trac.wordpress.org/changeset/51379">[51379]</a> to the 5.8 branch.
Fixes <a href="https://core.trac.wordpress.org/ticket/53604">#53604</a>.
Props aristath, jorbin, SergeyBiryukov, desrosj.
Unprops jorbin.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches58srcwpincludesblocksphp">branches/5.8/src/wp-includes/blocks.php</a></li>
<li><a href="#branches58srcwpincludesdeprecatedphp">branches/5.8/src/wp-includes/deprecated.php</a></li>
<li><a href="#branches58testsphpunittestspostgetTheExcerptphp">branches/5.8/tests/phpunit/tests/post/getTheExcerpt.php</a></li>
</ul>
<h3>Property Changed</h3>
<ul>
<li><a href="#branches58">branches/5.8/</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: branches/5.8
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- branches/5.8 2021-07-08 17:06:29 UTC (rev 51381)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ branches/5.8 2021-07-08 17:27:27 UTC (rev 51382)
</ins><a id="branches58"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: branches/5.8</h4>
<pre class="diff"><span>
</span></pre></div>
<a id="svnmergeinfo"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: svn:mergeinfo</h4></div>
<span class="cx" style="display: block; padding: 0 10px"> /branches/4.9:43557,43622
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/5.0:43681-43682,43684-43688,43719-43720,43723,43726-43727,43729-43731,43734-43744,43747,43751-43754,43758,43760-43765,43767-43770,43772,43774-43781,43783,43785,43790-43806,43808-43821,43825,43828,43830-43834,43836-43843,43846-43863,43867-43889,43891-43894,43897-43905,43908-43909,43911-43929,43931-43942,43946-43947,43949-43956,43959-43964,43967-43969,43988,43994,44014,44017,44047,44183,44185,44187-44206,44208-44213,44231-44232,44235,44248,44284,44287-44288
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/5.5:49373-49379,49381
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/trunk:51274,51277,51279-51284,51286-51289,51292-51294,51296,51304,51307,51309,51321-51324,51332,51343-51344,51349,51351-51353,51355-51356,51359,51362,51369-51371
</del><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/trunk:51274,51277,51279-51284,51286-51289,51292-51294,51296,51304,51307,51309,51321-51324,51332,51343-51344,51348-51349,51351-51353,51355-51356,51359,51362,51369-51371,51375
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="branches58srcwpincludesblocksphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.8/src/wp-includes/blocks.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.8/src/wp-includes/blocks.php 2021-07-08 17:06:29 UTC (rev 51381)
+++ branches/5.8/src/wp-includes/blocks.php 2021-07-08 17:27:27 UTC (rev 51382)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -710,9 +710,25 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'core/verse',
</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">- $allowed_blocks = array_merge( $allowed_inner_blocks, array( 'core/columns' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $allowed_wrapper_blocks = array(
+ 'core/columns',
+ 'core/column',
+ 'core/group',
+ );
</ins><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">+ * Filters the list of blocks that can be used as wrapper blocks, allowing
+ * excerpts to be generated from the `innerBlocks` of these wrappers.
+ *
+ * @since 5.8.0
+ *
+ * @param array $allowed_wrapper_blocks The list of allowed wrapper blocks.
+ */
+ $allowed_wrapper_blocks = apply_filters( 'excerpt_allowed_wrapper_blocks', $allowed_wrapper_blocks );
+
+ $allowed_blocks = array_merge( $allowed_inner_blocks, $allowed_wrapper_blocks );
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Filters the list of blocks that can contribute to the excerpt.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * If a dynamic block is added to this list, it must not generate another
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -729,8 +745,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $blocks as $block ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( in_array( $block['blockName'], $allowed_blocks, true ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $block['innerBlocks'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( 'core/columns' === $block['blockName'] ) {
- $output .= _excerpt_render_inner_columns_blocks( $block, $allowed_inner_blocks );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( in_array( $block['blockName'], $allowed_wrapper_blocks, true ) ) {
+ $output .= _excerpt_render_inner_blocks( $block, $allowed_blocks );
</ins><span class="cx" style="display: block; padding: 0 10px"> continue;
</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">@@ -753,24 +769,29 @@
</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">- * Render inner blocks from the `core/columns` block for generating an excerpt.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Render inner blocks from the allowed wrapper blocks
+ * for generating an excerpt.
</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.2.0
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.8
</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 array $columns The parsed columns block.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $parsed_block The parsed block.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array $allowed_blocks The list of allowed inner blocks.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string The rendered inner blocks.
</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 _excerpt_render_inner_columns_blocks( $columns, $allowed_blocks ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function _excerpt_render_inner_blocks( $parsed_block, $allowed_blocks ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $output = '';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( $columns['innerBlocks'] as $column ) {
- foreach ( $column['innerBlocks'] as $inner_block ) {
- if ( in_array( $inner_block['blockName'], $allowed_blocks, true ) && empty( $inner_block['innerBlocks'] ) ) {
- $output .= render_block( $inner_block );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( $parsed_block['innerBlocks'] as $inner_block ) {
+ if ( ! in_array( $inner_block['blockName'], $allowed_blocks, true ) ) {
+ continue;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( empty( $inner_block['innerBlocks'] ) ) {
+ $output .= render_block( $inner_block );
+ } else {
+ $output .= _excerpt_render_inner_blocks( $inner_block, $allowed_blocks );
+ }
</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 $output;
</span></span></pre></div>
<a id="branches58srcwpincludesdeprecatedphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.8/src/wp-includes/deprecated.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.8/src/wp-includes/deprecated.php 2021-07-08 17:06:29 UTC (rev 51381)
+++ branches/5.8/src/wp-includes/deprecated.php 2021-07-08 17:27:27 UTC (rev 51382)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4207,3 +4207,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><span class="cx" style="display: block; padding: 0 10px"> wp_strict_cross_origin_referrer();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * Render inner blocks from the `core/columns` block for generating an excerpt.
+ *
+ * @since 5.2.0
+ * @deprecated 5.8.0
+ *
+ * @access private
+ *
+ * @param array $columns The parsed columns block.
+ * @param array $allowed_blocks The list of allowed inner blocks.
+ * @return string The rendered inner blocks.
+ */
+function _excerpt_render_inner_columns_blocks( $columns, $allowed_blocks ) {
+ _deprecated_function( __FUNCTION__, '5.8.0', '_excerpt_render_inner_blocks()' );
+ return _excerpt_render_inner_blocks( $columns, $allowed_blocks );
+}
</ins></span></pre></div>
<a id="branches58testsphpunittestspostgetTheExcerptphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.8/tests/phpunit/tests/post/getTheExcerpt.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.8/tests/phpunit/tests/post/getTheExcerpt.php 2021-07-08 17:06:29 UTC (rev 51381)
+++ branches/5.8/tests/phpunit/tests/post/getTheExcerpt.php 2021-07-08 17:27:27 UTC (rev 51382)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -145,4 +145,63 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 'Bar', $found );
</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 53604
+ */
+ public function test_inner_blocks_excerpt() {
+ $content_1 = '<!-- wp:group -->
+<div class="wp-block-group"><!-- wp:columns -->
+<div class="wp-block-columns"><!-- wp:column -->
+<div class="wp-block-column"><!-- wp:paragraph -->
+<p>Column 1</p>
+<!-- /wp:paragraph --></div>
+<!-- /wp:column -->
+
+<!-- wp:column -->
+<div class="wp-block-column"><!-- wp:paragraph -->
+<p>Column 2</p>
+<!-- /wp:paragraph --></div>
+<!-- /wp:column --></div>
+<!-- /wp:columns --></div>
+<!-- /wp:group -->
+
+<!-- wp:paragraph -->
+<p></p>
+<!-- /wp:paragraph -->';
+
+ $content_2 = '<!-- wp:group -->
+<div class="wp-block-group"><!-- wp:paragraph -->
+<p>Paragraph inside group block</p>
+<!-- /wp:paragraph --></div>
+<!-- /wp:group -->
+
+<!-- wp:paragraph -->
+<p></p>
+<!-- /wp:paragraph -->';
+
+ $post_1 = self::factory()->post->create_and_get(
+ array(
+ 'post_content' => $content_1,
+ 'post_excerpt' => '',
+ )
+ );
+
+ $post_2 = self::factory()->post->create_and_get(
+ array(
+ 'post_content' => $content_2,
+ 'post_excerpt' => '',
+ )
+ );
+
+ $this->assertSame(
+ 'Column 1 Column 2',
+ get_the_excerpt( ( new WP_Query( array( 'p' => $post_1->ID ) ) )->posts[0] )
+ );
+
+ $this->assertSame(
+ 'Paragraph inside group block',
+ get_the_excerpt( ( new WP_Query( array( 'p' => $post_2->ID ) ) )->posts[0] )
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>