<!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>[56560] trunk: Posts, Post Types: Avoid unnecessarily parsing blocks twice in `wp_trim_excerpt()`.</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/56560">56560</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/56560","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>flixos90</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-09-12 19:18:34 +0000 (Tue, 12 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'>Posts, Post Types: Avoid unnecessarily parsing blocks twice in `wp_trim_excerpt()`.
All blocks relevant for the excerpt are already being parsed in `excerpt_remove_blocks()`. Therefore running `do_blocks()` on the post content only to create the excerpt is unnecessary and wasteful from a performance perspective.
Props thekt12, spacedmonkey, mukesh27, joemcgill.
Fixes <a href="https://core.trac.wordpress.org/ticket/58682">#58682</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesblocksphp">trunk/src/wp-includes/blocks.php</a></li>
<li><a href="#trunksrcwpincludesformattingphp">trunk/src/wp-includes/formatting.php</a></li>
<li><a href="#trunktestsphpunittestsformattingwpTrimExcerptphp">trunk/tests/phpunit/tests/formatting/wpTrimExcerpt.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesblocksphp"></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/blocks.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/blocks.php 2023-09-12 15:21:02 UTC (rev 56559)
+++ trunk/src/wp-includes/blocks.php 2023-09-12 19:18:34 UTC (rev 56560)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -956,6 +956,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string The parsed and filtered content.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function excerpt_remove_blocks( $content ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! has_blocks( $content ) ) {
+ return $content;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $allowed_inner_blocks = array(
</span><span class="cx" style="display: block; padding: 0 10px"> // Classic blocks have their blockName set to null.
</span><span class="cx" style="display: block; padding: 0 10px"> null,
</span></span></pre></div>
<a id="trunksrcwpincludesformattingphp"></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/formatting.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/formatting.php 2023-09-12 15:21:02 UTC (rev 56559)
+++ trunk/src/wp-includes/formatting.php 2023-09-12 19:18:34 UTC (rev 56560)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3980,18 +3980,29 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * within the excerpt are stripped out. Modifying the tags here
</span><span class="cx" style="display: block; padding: 0 10px"> * is wasteful and can lead to bugs in the image counting logic.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $filter_removed = remove_filter( 'the_content', 'wp_filter_content_tags' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $filter_image_removed = remove_filter( 'the_content', 'wp_filter_content_tags' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Temporarily unhook do_blocks() since excerpt_remove_blocks( $text )
+ * handels block rendering needed for excerpt.
+ */
+ $filter_block_removed = remove_filter( 'the_content', 'do_blocks', 9 );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /** This filter is documented in wp-includes/post-template.php */
</span><span class="cx" style="display: block; padding: 0 10px"> $text = apply_filters( 'the_content', $text );
</span><span class="cx" style="display: block; padding: 0 10px"> $text = str_replace( ']]>', ']]>', $text );
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Restore the original filter if removed.
+ if ( $filter_block_removed ) {
+ add_filter( 'the_content', 'do_blocks', 9 );
+ }
+
+ /*
</ins><span class="cx" style="display: block; padding: 0 10px"> * Only restore the filter callback if it was removed above. The logic
</span><span class="cx" style="display: block; padding: 0 10px"> * to unhook and restore only applies on the default priority of 10,
</span><span class="cx" style="display: block; padding: 0 10px"> * which is generally used for the filter callback in WordPress core.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $filter_removed ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $filter_image_removed ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'the_content', 'wp_filter_content_tags' );
</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="trunktestsphpunittestsformattingwpTrimExcerptphp"></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/formatting/wpTrimExcerpt.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/formatting/wpTrimExcerpt.php 2023-09-12 15:21:02 UTC (rev 56559)
+++ trunk/tests/phpunit/tests/formatting/wpTrimExcerpt.php 2023-09-12 19:18:34 UTC (rev 56560)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -148,4 +148,85 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Assert that the filter callback was not restored after running 'the_content'.
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertFalse( has_filter( 'the_content', 'wp_filter_content_tags' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Tests that `wp_trim_excerpt()` does process valid blocks.
+ *
+ * @ticket 58682
+ *
+ * @covers ::wp_trim_excerpt
+ */
+ public function test_wp_trim_excerpt_check_if_block_renders() {
+ $post = self::factory()->post->create(
+ array(
+ 'post_content' => '<!-- wp:paragraph --> <p>A test paragraph</p> <!-- /wp:paragraph -->',
+ )
+ );
+
+ $output_text = wp_trim_excerpt( '', $post );
+
+ $this->assertSame( 'A test paragraph', $output_text, 'wp_trim_excerpt() did not process paragraph block.' );
+ }
+
+ /**
+ * Tests that `wp_trim_excerpt()` unhooks `do_blocks()` from 'the_content' filter.
+ *
+ * @ticket 58682
+ *
+ * @covers ::wp_trim_excerpt
+ */
+ public function test_wp_trim_excerpt_unhooks_do_blocks() {
+ $post = self::factory()->post->create();
+
+ /*
+ * Record that during 'the_content' filter run by wp_trim_excerpt() the
+ * do_blocks() callback is not used.
+ */
+ $has_filter = true;
+ add_filter(
+ 'the_content',
+ static function( $content ) use ( &$has_filter ) {
+ $has_filter = has_filter( 'the_content', 'do_blocks' );
+ return $content;
+ }
+ );
+
+ wp_trim_excerpt( '', $post );
+
+ $this->assertFalse( $has_filter, 'do_blocks() was not unhooked in wp_trim_excerpt()' );
+ }
+
+ /**
+ * Tests that `wp_trim_excerpt()` doesn't permanently unhook `do_blocks()` from 'the_content' filter.
+ *
+ * @ticket 58682
+ *
+ * @covers ::wp_trim_excerpt
+ */
+ public function test_wp_trim_excerpt_should_not_permanently_unhook_do_blocks() {
+ $post = self::factory()->post->create();
+
+ wp_trim_excerpt( '', $post );
+
+ $this->assertSame( 9, has_filter( 'the_content', 'do_blocks' ), 'do_blocks() was not restored in wp_trim_excerpt()' );
+ }
+
+ /**
+ * Tests that `wp_trim_excerpt()` doesn't restore `do_blocks()` if it was previously unhooked.
+ *
+ * @ticket 58682
+ *
+ * @covers ::wp_trim_excerpt
+ */
+ public function test_wp_trim_excerpt_does_not_restore_do_blocks_if_previously_unhooked() {
+ $post = self::factory()->post->create();
+
+ // Remove do_blocks() from 'the_content' filter generally.
+ remove_filter( 'the_content', 'do_blocks', 9 );
+
+ wp_trim_excerpt( '', $post );
+
+ // Assert that the filter callback was not restored after running 'the_content'.
+ $this->assertFalse( has_filter( 'the_content', 'do_blocks' ) );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>