<!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>[56618] trunk: Blocks: Implement block insertion functions.</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/56618">56618</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/56618","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-19 12:34:50 +0000 (Tue, 19 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'>Blocks: Implement block insertion functions.
For <a href="https://core.trac.wordpress.org/ticket/59313">#59313</a>, we need to implement functions to insert a given parsed block into another parsed block's inner blocks, and to prepend and append to that array, respectively.
We will use those functions in combination with `traverse_and_serialize_blocks` (see <a href="https://core.trac.wordpress.org/ticket/59327">#59327</a>) to implement automatic insertion of hooked blocks into block templates and patterns.
Props gziolo.
Fixes <a href="https://core.trac.wordpress.org/ticket/59385">#59385</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesblocksphp">trunk/src/wp-includes/blocks.php</a></li>
<li><a href="#trunktestsphpunittestsblocksblockHooksphp">trunk/tests/phpunit/tests/blocks/blockHooks.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-19 12:28:25 UTC (rev 56617)
+++ trunk/src/wp-includes/blocks.php 2023-09-19 12:34:50 UTC (rev 56618)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -761,6 +761,84 @@
</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">+ * Insert a parsed block into a parent block's inner blocks.
+ *
+ * Given a parsed block, a block index, and a chunk index, insert another parsed block
+ * into the parent block at the given indices.
+ *
+ * Note that the this mutates the parent block by inserting into the parent's `innerBlocks`
+ * array, and by updating the parent's `innerContent` array accordingly.
+ *
+ * @since 6.4.0
+ *
+ * @param array $parent_block The parent block.
+ * @param int $block_index The index specifying the insertion position among the parent block's inner blocks.
+ * @param int $chunk_index The index specifying the insertion position among the parent block's inner content chunks.
+ * @param array $inserted_block The block to insert.
+ * @return void
+ */
+function insert_inner_block( &$parent_block, $block_index, $chunk_index, $inserted_block ) {
+ array_splice( $parent_block['innerBlocks'], $block_index, 0, array( $inserted_block ) );
+
+ /*
+ * Since WP_Block::render() iterates over `inner_content` (rather than `inner_blocks`)
+ * when rendering blocks, we also need to insert a value (`null`, to mark a block
+ * location) into that array.
+ */
+ array_splice( $parent_block['innerContent'], $chunk_index, 0, array( null ) );
+}
+
+/**
+ * Prepend a parsed block to a parent block's inner blocks.
+ *
+ * Given a parsed block, prepend another parsed block to the parent block's inner blocks.
+ *
+ * Note that the this mutates the parent block by inserting into the parent's `innerBlocks`
+ * array, and by updating the parent's `innerContent` array accordingly.
+ *
+ * @since 6.4.0
+ *
+ * @param array $parent_block The parent block.
+ * @param array $inserted_block The block to insert.
+ * @return void
+ */
+function prepend_inner_block( &$parent_block, $inserted_block ) {
+ $chunk_index = 0;
+ for ( $index = 0; $index < count( $parent_block['innerContent'] ); $index++ ) {
+ if ( is_null( $parent_block['innerContent'][ $index ] ) ) {
+ $chunk_index = $index;
+ break;
+ }
+ }
+ insert_inner_block( $parent_block, 0, $chunk_index, $inserted_block );
+}
+
+/**
+ * Append a parsed block to a parent block's inner blocks.
+ *
+ * Given a parsed block, append another parsed block to the parent block's inner blocks.
+ *
+ * Note that the this mutates the parent block by inserting into the parent's `innerBlocks`
+ * array, and by updating the parent's `innerContent` array accordingly.
+ *
+ * @since 6.4.0
+ *
+ * @param array $parent_block The parent block.
+ * @param array $inserted_block The block to insert.
+ * @return void
+ */
+function append_inner_block( &$parent_block, $inserted_block ) {
+ $chunk_index = count( $parent_block['innerContent'] );
+ for ( $index = count( $parent_block['innerContent'] ); $index > 0; $index-- ) {
+ if ( is_null( $parent_block['innerContent'][ $index - 1 ] ) ) {
+ $chunk_index = $index;
+ break;
+ }
+ }
+ insert_inner_block( $parent_block, count( $parent_block['innerBlocks'] ), $chunk_index, $inserted_block );
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Given an array of attributes, returns a string in the serialized attributes
</span><span class="cx" style="display: block; padding: 0 10px"> * format prepared for post content.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre></div>
<a id="trunktestsphpunittestsblocksblockHooksphp"></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/blockHooks.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/blocks/blockHooks.php 2023-09-19 12:28:25 UTC (rev 56617)
+++ trunk/tests/phpunit/tests/blocks/blockHooks.php 2023-09-19 12:34:50 UTC (rev 56618)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -17,9 +17,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.4.0
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function tear_down() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $registry = WP_Block_Type_Registry::get_instance();
-
- foreach ( array( 'tests/my-block', 'tests/my-container-block' ) as $block_name ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $registry = WP_Block_Type_Registry::get_instance();
+ $block_names = array(
+ 'tests/injected-one',
+ 'tests/injected-two',
+ );
+ foreach ( $block_names as $block_name ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $registry->is_registered( $block_name ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $registry->unregister( $block_name );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -97,4 +100,157 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'block hooked at the last child position'
</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 59385
+ *
+ * @covers ::insert_inner_block
+ *
+ * @dataProvider data_insert_inner_block
+ *
+ * @param string $block_index Block index to insert the block at.
+ * @param string $expected_markup Expected markup after the block is inserted.
+ */
+ public function test_insert_inner_block( $block_index, $expected_markup ) {
+ $original_markup = <<<HTML
+<!-- wp:tests/group {"layout":{"type":"constrained"}} -->
+ <div class="wp-block-group">
+ <!-- wp:paragraph -->
+ <p>Foo</p>
+ <!-- /wp:paragraph -->
+ </div>
+<!-- /wp:tests/group -->
+HTML;
+
+ $inserted_block = array(
+ 'blockName' => 'tests/hooked-block',
+ 'attrs' => array(),
+ 'innerBlocks' => array(),
+ 'innerHTML' => '',
+ 'innerContent' => array(),
+ );
+
+ $expected = parse_blocks( $expected_markup )[0];
+ $block = parse_blocks( $original_markup )[0];
+ insert_inner_block( $block, $block_index, 1, $inserted_block );
+ $this->assertSame( $expected, $block );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array[]
+ */
+ public function data_insert_inner_block() {
+ $expected_before_markup = <<<HTML
+<!-- wp:tests/group {"layout":{"type":"constrained"}} -->
+ <div class="wp-block-group">
+ <!-- wp:tests/hooked-block /--><!-- wp:paragraph -->
+ <p>Foo</p>
+ <!-- /wp:paragraph -->
+ </div>
+<!-- /wp:tests/group -->
+HTML;
+
+ $expected_after_markup = <<<HTML
+<!-- wp:tests/group {"layout":{"type":"constrained"}} -->
+ <div class="wp-block-group">
+ <!-- wp:paragraph -->
+ <p>Foo</p>
+ <!-- /wp:paragraph --><!-- wp:tests/hooked-block /-->
+ </div>
+<!-- /wp:tests/group -->
+HTML;
+
+ return array(
+ 'insert before given block' => array(
+ 'block_index' => 0,
+ 'expected_markup' => $expected_before_markup,
+ ),
+ 'insert after given block' => array(
+ 'block_index' => 1,
+ 'expected_markup' => $expected_after_markup,
+ ),
+ );
+ }
+
+ /**
+ * @ticket 59385
+ *
+ * @covers ::prepend_inner_block
+ */
+ public function test_prepend_inner_block() {
+ $original_markup = <<<HTML
+<!-- wp:tests/group {"layout":{"type":"constrained"}} -->
+ <div class="wp-block-group">
+ <!-- wp:paragraph -->
+ <p>Foo</p>
+ <!-- /wp:paragraph -->
+ </div>
+<!-- /wp:tests/group -->
+HTML;
+
+ $inserted_block = array(
+ 'blockName' => 'tests/hooked-block',
+ 'attrs' => array(),
+ 'innerBlocks' => array(),
+ 'innerHTML' => '',
+ 'innerContent' => array(),
+ );
+
+ $expected_markup = <<<HTML
+<!-- wp:tests/group {"layout":{"type":"constrained"}} -->
+ <div class="wp-block-group">
+ <!-- wp:tests/hooked-block /--><!-- wp:paragraph -->
+ <p>Foo</p>
+ <!-- /wp:paragraph -->
+ </div>
+<!-- /wp:tests/group -->
+HTML;
+
+ $expected = parse_blocks( $expected_markup )[0];
+ $block = parse_blocks( $original_markup )[0];
+ prepend_inner_block( $block, $inserted_block );
+ $this->assertSame( $expected, $block );
+ }
+
+ /**
+ * @ticket 59385
+ *
+ * @covers ::append_inner_block
+ */
+ public function test_append_inner_block() {
+ $original_markup = <<<HTML
+<!-- wp:tests/group {"layout":{"type":"constrained"}} -->
+ <div class="wp-block-group">
+ <!-- wp:paragraph -->
+ <p>Foo</p>
+ <!-- /wp:paragraph -->
+ </div>
+<!-- /wp:tests/group -->
+HTML;
+
+ $inserted_block = array(
+ 'blockName' => 'tests/hooked-block',
+ 'attrs' => array(),
+ 'innerBlocks' => array(),
+ 'innerHTML' => '',
+ 'innerContent' => array(),
+ );
+
+ $expected_markup = <<<HTML
+<!-- wp:tests/group {"layout":{"type":"constrained"}} -->
+ <div class="wp-block-group">
+ <!-- wp:paragraph -->
+ <p>Foo</p>
+ <!-- /wp:paragraph --><!-- wp:tests/hooked-block /-->
+ </div>
+<!-- /wp:tests/group -->
+HTML;
+
+ $expected = parse_blocks( $expected_markup )[0];
+ $block = parse_blocks( $original_markup )[0];
+ append_inner_block( $block, $inserted_block );
+ $this->assertSame( $expected, $block );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>