<!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>[59124] trunk: Block Hooks: Respect `"multiple": false` in hooked blocks.</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/59124">59124</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/59124","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>2024-09-30 12:21:31 +0000 (Mon, 30 Sep 2024)</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: Respect `"multiple": false` in hooked blocks.
If a prospective hooked block has its `multiple` block-supports field set to `false` (thus allowing only one instance of the block to be present), ensure that:
1. Only one instance of the block will be inserted if it's not yet present in the current context.
2. The block will not be inserted at all if an instance of it is already present in the current context.
As always in Block Hooks parlance, "context" denotes the containing template, template part, pattern, or navigation post that a hooked block is supposed to be inserted into.
The markup of a webpage that uses a Block Theme typically comprises a number of such contexts -- one template and any number of template parts, patterns, and navigation posts. Note that the limitation imposed by this changeset only applies on a per-context basis, so it's still possible that the resulting page contains more than one instance of a hooked block with `"multiple": false` set, as each context could contribute up to one such instance.
Props bernhard-reiter, jonsurrell, gziolo.
Fixes <a href="https://core.trac.wordpress.org/ticket/61902">#61902</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>
</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 2024-09-30 11:03:51 UTC (rev 59123)
+++ trunk/src/wp-includes/blocks.php 2024-09-30 12:21:31 UTC (rev 59124)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1056,9 +1056,77 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $after_block_visitor = make_after_block_visitor( $hooked_blocks, $context, $callback );
</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">- $blocks = parse_blocks( $content );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $block_allows_multiple_instances = array();
+ /*
+ * Remove hooked blocks from `$hooked_block_types` if they have `multiple` set to false and
+ * are already present in `$content`.
+ */
+ foreach ( $hooked_blocks as $anchor_block_type => $relative_positions ) {
+ foreach ( $relative_positions as $relative_position => $hooked_block_types ) {
+ foreach ( $hooked_block_types as $index => $hooked_block_type ) {
+ $hooked_block_type_definition =
+ WP_Block_Type_Registry::get_instance()->get_registered( $hooked_block_type );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return traverse_and_serialize_blocks( $blocks, $before_block_visitor, $after_block_visitor );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $block_allows_multiple_instances[ $hooked_block_type ] =
+ block_has_support( $hooked_block_type_definition, 'multiple', true );
+
+ if (
+ ! $block_allows_multiple_instances[ $hooked_block_type ] &&
+ has_block( $hooked_block_type, $content )
+ ) {
+ unset( $hooked_blocks[ $anchor_block_type ][ $relative_position ][ $index ] );
+ }
+ }
+ if ( empty( $hooked_blocks[ $anchor_block_type ][ $relative_position ] ) ) {
+ unset( $hooked_blocks[ $anchor_block_type ][ $relative_position ] );
+ }
+ }
+ if ( empty( $hooked_blocks[ $anchor_block_type ] ) ) {
+ unset( $hooked_blocks[ $anchor_block_type ] );
+ }
+ }
+
+ /*
+ * We also need to cover the case where the hooked block is not present in
+ * `$content` at first and we're allowed to insert it once -- but not again.
+ */
+ $suppress_single_instance_blocks = static function ( $hooked_block_types ) use ( &$block_allows_multiple_instances, $content ) {
+ static $single_instance_blocks_present_in_content = array();
+ foreach ( $hooked_block_types as $index => $hooked_block_type ) {
+ if ( ! isset( $block_allows_multiple_instances[ $hooked_block_type ] ) ) {
+ $hooked_block_type_definition =
+ WP_Block_Type_Registry::get_instance()->get_registered( $hooked_block_type );
+
+ $block_allows_multiple_instances[ $hooked_block_type ] =
+ block_has_support( $hooked_block_type_definition, 'multiple', true );
+ }
+
+ if ( $block_allows_multiple_instances[ $hooked_block_type ] ) {
+ continue;
+ }
+
+ // The block doesn't allow multiple instances, so we need to check if it's already present.
+ if (
+ in_array( $hooked_block_type, $single_instance_blocks_present_in_content, true ) ||
+ has_block( $hooked_block_type, $content )
+ ) {
+ unset( $hooked_block_types[ $index ] );
+ } else {
+ // We can insert the block once, but need to remember not to insert it again.
+ $single_instance_blocks_present_in_content[] = $hooked_block_type;
+ }
+ }
+ return $hooked_block_types;
+ };
+ add_filter( 'hooked_block_types', $suppress_single_instance_blocks, PHP_INT_MAX );
+ $content = traverse_and_serialize_blocks(
+ parse_blocks( $content ),
+ $before_block_visitor,
+ $after_block_visitor
+ );
+ remove_filter( 'hooked_block_types', $suppress_single_instance_blocks, PHP_INT_MAX );
+
+ return $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></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 2024-09-30 11:03:51 UTC (rev 59123)
+++ trunk/tests/phpunit/tests/blocks/applyBlockHooksToContent.php 2024-09-30 12:21:31 UTC (rev 59124)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -27,6 +27,27 @@
</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-with-multiple-false',
+ array(
+ 'block_hooks' => array(
+ 'tests/other-anchor-block' => 'after',
+ ),
+ 'supports' => array(
+ 'multiple' => false,
+ ),
+ )
+ );
+
+ register_block_type(
+ 'tests/dynamically-hooked-block-with-multiple-false',
+ array(
+ 'supports' => array(
+ 'multiple' => false,
+ ),
+ )
+ );
</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">@@ -38,6 +59,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $registry = WP_Block_Type_Registry::get_instance();
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $registry->unregister( 'tests/hooked-block-with-multiple-false' );
+ $registry->unregister( 'tests/dynamically-hooked-block-with-multiple-false' );
</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">@@ -67,4 +90,82 @@
</span><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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @ticket 61902
+ */
+ public function test_apply_block_hooks_to_content_respect_multiple_false() {
+ $context = new WP_Block_Template();
+ $context->content = '<!-- wp:tests/hooked-block-with-multiple-false /--><!-- wp:tests/other-anchor-block /-->';
+
+ $actual = apply_block_hooks_to_content( $context->content, $context, 'insert_hooked_blocks' );
+ $this->assertSame(
+ '<!-- wp:tests/hooked-block-with-multiple-false /--><!-- wp:tests/other-anchor-block /-->',
+ $actual
+ );
+ }
+
+ /**
+ * @ticket 61902
+ */
+ public function test_apply_block_hooks_to_content_respect_multiple_false_after_inserting_once() {
+ $context = new WP_Block_Template();
+ $context->content = '<!-- wp:tests/other-anchor-block /--><!-- wp:tests/other-block /--><!-- wp:tests/other-anchor-block /-->';
+
+ $actual = apply_block_hooks_to_content( $context->content, $context, 'insert_hooked_blocks' );
+ $this->assertSame(
+ '<!-- wp:tests/other-anchor-block /--><!-- wp:tests/hooked-block-with-multiple-false /--><!-- wp:tests/other-block /--><!-- wp:tests/other-anchor-block /-->',
+ $actual
+ );
+ }
+
+ /**
+ * @ticket 61902
+ */
+ public function test_apply_block_hooks_to_content_respect_multiple_false_with_filter() {
+ $filter = function ( $hooked_block_types, $relative_position, $anchor_block_type ) {
+ if ( 'tests/yet-another-anchor-block' === $anchor_block_type && 'after' === $relative_position ) {
+ $hooked_block_types[] = 'tests/dynamically-hooked-block-with-multiple-false';
+ }
+
+ return $hooked_block_types;
+ };
+
+ $context = new WP_Block_Template();
+ $context->content = '<!-- wp:tests/dynamically-hooked-block-with-multiple-false /--><!-- wp:tests/yet-another-anchor-block /-->';
+
+ add_filter( 'hooked_block_types', $filter, 10, 3 );
+ $actual = apply_block_hooks_to_content( $context->content, $context, 'insert_hooked_blocks' );
+ remove_filter( 'hooked_block_types', $filter, 10 );
+
+ $this->assertSame(
+ '<!-- wp:tests/dynamically-hooked-block-with-multiple-false /--><!-- wp:tests/yet-another-anchor-block /-->',
+ $actual
+ );
+ }
+
+ /**
+ * @ticket 61902
+ */
+ public function test_apply_block_hooks_to_content_respect_multiple_false_after_inserting_once_with_filter() {
+ $filter = function ( $hooked_block_types, $relative_position, $anchor_block_type ) {
+ if ( 'tests/yet-another-anchor-block' === $anchor_block_type && 'after' === $relative_position ) {
+ $hooked_block_types[] = 'tests/dynamically-hooked-block-with-multiple-false';
+ }
+
+ return $hooked_block_types;
+ };
+
+ $context = new WP_Block_Template();
+ $context->content = '<!-- wp:tests/yet-another-anchor-block /--><!-- wp:tests/other-block /--><!-- wp:tests/yet-another-anchor-block /-->';
+
+ add_filter( 'hooked_block_types', $filter, 10, 3 );
+ $actual = apply_block_hooks_to_content( $context->content, $context, 'insert_hooked_blocks' );
+ remove_filter( 'hooked_block_types', $filter, 10 );
+
+ $this->assertSame(
+ '<!-- wp:tests/yet-another-anchor-block /--><!-- wp:tests/dynamically-hooked-block-with-multiple-false /--><!-- wp:tests/other-block /--><!-- wp:tests/yet-another-anchor-block /-->',
+ $actual
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>