<!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>[60173] trunk: Block Hooks: Suppress insertion next to post content wrapper 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/60173">60173</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/60173","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>2025-04-18 12:55:40 +0000 (Fri, 18 Apr 2025)</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'>Block Hooks: Suppress insertion next to post content wrapper block.
As of <a href="https://core.trac.wordpress.org/changeset/59523">[59523]</a>, Block Hooks are applied to post content. In order to allow for insertion of a hooked block as `first_child` or `last_child` of the containing Post Content block, we wrap the block's post content (as obtained from the DB) in a temporary `<!-- wp:post-content -->` wrapper block, apply the Block Hooks algorithm to the resulting markup, and remove the wrapper block. (The same technique is applied for the Synced Pattern block -- see <a href="https://core.trac.wordpress.org/changeset/59543">[59543]</a> -- as well as the Navigation block.)
However, this caused a problem when a hooked block was marked for insertion before `before` or `after` a Post Content block: The logic that's supposed to remove the temporary wrapper block after the Block Hooks algorithm runs erroneously removed that hooked block's delimiter instead of the wrapper block, producing garbled markup as a result.
This changeset fixes the issue by adding a `hooked_block_types` filter (with `PHP_INT_MAX` priority) that removes any blocks hooked `before` or `after` a Post Content block, ''if'' the current context is a post object. This prevents any blocks hooked that way from being "absorbed" into the corresponding post object's content; it retains the ability to hook blocks `before` and `after` a Post Content block in any other context (e.g. a template). (The same principle is applied to Synced Pattern and Navigation blocks.)
Props obenland, jorbin, gziolo, bernhard-reiter.
Fixes <a href="https://core.trac.wordpress.org/ticket/63287">#63287</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesblocksphp">trunk/src/wp-includes/blocks.php</a></li>
<li><a href="#trunktestsphpunittestsblocksapplyBlockHooksToContentphp">trunk/tests/phpunit/tests/blocks/applyBlockHooksToContent.php</a></li>
<li><a href="#trunktestsphpunittestsblocksapplyBlockHooksToContentFromPostObjectphp">trunk/tests/phpunit/tests/blocks/applyBlockHooksToContentFromPostObject.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 2025-04-17 12:08:25 UTC (rev 60172)
+++ trunk/src/wp-includes/blocks.php 2025-04-18 12:55:40 UTC (rev 60173)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1248,8 +1248,25 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $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">+ /*
+ * We need to avoid inserting any blocks hooked into the `before` and `after` positions
+ * of the temporary wrapper block that we create to wrap the content.
+ * See https://core.trac.wordpress.org/ticket/63287 for more details.
+ */
+ $suppress_blocks_from_insertion_before_and_after_wrapper_block = static function ( $hooked_block_types, $relative_position, $anchor_block_type ) use ( $wrapper_block_type ) {
+ if (
+ $wrapper_block_type === $anchor_block_type &&
+ in_array( $relative_position, array( 'before', 'after' ), true )
+ ) {
+ return array();
+ }
+ return $hooked_block_types;
+ };
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Apply Block Hooks.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_filter( 'hooked_block_types', $suppress_blocks_from_insertion_before_and_after_wrapper_block, PHP_INT_MAX, 3 );
</ins><span class="cx" style="display: block; padding: 0 10px"> $content = apply_block_hooks_to_content( $content, $post, $callback );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ remove_filter( 'hooked_block_types', $suppress_blocks_from_insertion_before_and_after_wrapper_block, PHP_INT_MAX );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Finally, we need to remove the temporary wrapper block.
</span><span class="cx" style="display: block; padding: 0 10px"> $content = remove_serialized_parent_block( $content );
</span></span></pre></div>
<a id="trunktestsphpunittestsblocksapplyBlockHooksToContentphp"></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/blocks/applyBlockHooksToContent.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/blocks/applyBlockHooksToContent.php 2025-04-17 12:08:25 UTC (rev 60172)
+++ trunk/tests/phpunit/tests/blocks/applyBlockHooksToContent.php 2025-04-18 12:55:40 UTC (rev 60173)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -17,6 +17,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Set up.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 61902.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 63287.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function wpSetUpBeforeClass() {
</span><span class="cx" style="display: block; padding: 0 10px"> register_block_type(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -23,7 +24,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'tests/hooked-block',
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'block_hooks' => array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'tests/anchor-block' => 'after',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'core/post-content' => 'after',
</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 class="lines" style="display: block; padding: 0 10px; color: #888">@@ -79,14 +80,15 @@
</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 61902
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 63287
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_apply_block_hooks_to_content_inserts_hooked_block() {
</span><span class="cx" style="display: block; padding: 0 10px"> $context = new WP_Block_Template();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $context->content = '<!-- wp:tests/anchor-block /-->';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $context->content = '<!-- wp:post-content /-->';
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $actual = apply_block_hooks_to_content( $context->content, $context, 'insert_hooked_blocks' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '<!-- wp:tests/anchor-block /--><!-- wp:tests/hooked-block /-->',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '<!-- wp:post-content /--><!-- wp:tests/hooked-block /-->',
</ins><span class="cx" style="display: block; padding: 0 10px"> $actual
</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">@@ -93,9 +95,10 @@
</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 61074
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 63287
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_apply_block_hooks_to_content_with_context_set_to_null() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $content = '<!-- wp:tests/anchor-block /-->';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $content = '<!-- wp:post-content /-->';
</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"> * apply_block_hooks_to_content() will fall back to the global $post object (via get_post())
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -106,7 +109,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $actual = apply_block_hooks_to_content( $content, null, 'insert_hooked_blocks' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '<!-- wp:tests/anchor-block /--><!-- wp:tests/hooked-block /-->',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '<!-- wp:post-content /--><!-- wp:tests/hooked-block /-->',
</ins><span class="cx" style="display: block; padding: 0 10px"> $actual
</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="trunktestsphpunittestsblocksapplyBlockHooksToContentFromPostObjectphp"></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/blocks/applyBlockHooksToContentFromPostObject.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/blocks/applyBlockHooksToContentFromPostObject.php 2025-04-17 12:08:25 UTC (rev 60172)
+++ trunk/tests/phpunit/tests/blocks/applyBlockHooksToContentFromPostObject.php 2025-04-18 12:55:40 UTC (rev 60173)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -88,6 +88,17 @@
</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">+
+ register_block_type(
+ 'tests/hooked-block-after-post-content',
+ array(
+ 'block_hooks' => array(
+ 'core/post-content' => 'after',
+ ),
+ )
+ );
+
+ register_block_type( 'tests/dynamically-hooked-block-before-post-content' );
</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 class="lines" style="display: block; padding: 0 10px; color: #888">@@ -100,6 +111,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $registry->unregister( 'tests/hooked-block' );
</span><span class="cx" style="display: block; padding: 0 10px"> $registry->unregister( 'tests/hooked-block-first-child' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $registry->unregister( 'tests/hooked-block-after-post-content' );
+ $registry->unregister( 'tests/dynamically-hooked-block-before-post-content' );
</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 class="lines" style="display: block; padding: 0 10px; color: #888">@@ -131,6 +144,33 @@
</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 63287
+ */
+ public function test_apply_block_hooks_to_content_from_post_object_does_not_insert_hooked_block_before_container_block() {
+ $filter = function ( $hooked_block_types, $relative_position, $anchor_block_type ) {
+ if ( 'core/post-content' === $anchor_block_type && 'before' === $relative_position ) {
+ $hooked_block_types[] = 'tests/dynamically-hooked-block-before-post-content';
+ }
+
+ return $hooked_block_types;
+ };
+
+ $expected = '<!-- wp:tests/hooked-block-first-child /-->' .
+ self::$post->post_content .
+ '<!-- wp:tests/hooked-block /-->';
+
+ add_filter( 'hooked_block_types', $filter, 10, 3 );
+ $actual = apply_block_hooks_to_content_from_post_object(
+ self::$post->post_content,
+ self::$post,
+ 'insert_hooked_blocks'
+ );
+ remove_filter( 'hooked_block_types', $filter, 10 );
+
+ $this->assertSame( $expected, $actual );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 62716
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_apply_block_hooks_to_content_from_post_object_inserts_hooked_block_if_content_contains_no_blocks() {
</span></span></pre>
</div>
</div>
</body>
</html>