<!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>[58303] trunk: Editor: resolve patterns server side.</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/58303">58303</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/58303","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>ellatrix</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-06-03 18:30:02 +0000 (Mon, 03 Jun 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'>Editor: resolve patterns server side.
See https://github.com/WordPress/gutenberg/pull/60349.
See https://github.com/WordPress/gutenberg/pull/61757.
See https://github.com/WordPress/wordpress-develop/pull/6673.
Fixes <a href="https://core.trac.wordpress.org/ticket/61228">#61228</a>.
Props ellatrix, antonvlasenko.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesblocksphp">trunk/src/wp-includes/blocks.php</a></li>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestblockpatternscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php</a></li>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswpresttemplatescontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsblocksresolvePatternBlocksphp">trunk/tests/phpunit/tests/blocks/resolvePatternBlocks.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-06-03 17:36:35 UTC (rev 58302)
+++ trunk/src/wp-includes/blocks.php 2024-06-03 18:30:02 UTC (rev 58303)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1519,6 +1519,83 @@
</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">+ * Replaces patterns in a block tree with their content.
+ *
+ * @since 6.6.0
+ *
+ * @param array $blocks An array blocks.
+ *
+ * @return array An array of blocks with patterns replaced by their content.
+ */
+function resolve_pattern_blocks( $blocks ) {
+ static $inner_content;
+ // Keep track of seen references to avoid infinite loops.
+ static $seen_refs = array();
+ $i = 0;
+ while ( $i < count( $blocks ) ) {
+ if ( 'core/pattern' === $blocks[ $i ]['blockName'] ) {
+ $attrs = $blocks[ $i ]['attrs'];
+
+ if ( empty( $attrs['slug'] ) ) {
+ ++$i;
+ continue;
+ }
+
+ $slug = $attrs['slug'];
+
+ if ( isset( $seen_refs[ $slug ] ) ) {
+ // Skip recursive patterns.
+ array_splice( $blocks, $i, 1 );
+ continue;
+ }
+
+ $registry = WP_Block_Patterns_Registry::get_instance();
+ $pattern = $registry->get_registered( $slug );
+
+ // Skip unknown patterns.
+ if ( ! $pattern ) {
+ ++$i;
+ continue;
+ }
+
+ $blocks_to_insert = parse_blocks( $pattern['content'] );
+ $seen_refs[ $slug ] = true;
+ $prev_inner_content = $inner_content;
+ $inner_content = null;
+ $blocks_to_insert = resolve_pattern_blocks( $blocks_to_insert );
+ $inner_content = $prev_inner_content;
+ unset( $seen_refs[ $slug ] );
+ array_splice( $blocks, $i, 1, $blocks_to_insert );
+
+ // If we have inner content, we need to insert nulls in the
+ // inner content array, otherwise serialize_blocks will skip
+ // blocks.
+ if ( $inner_content ) {
+ $null_indices = array_keys( $inner_content, null, true );
+ $content_index = $null_indices[ $i ];
+ $nulls = array_fill( 0, count( $blocks_to_insert ), null );
+ array_splice( $inner_content, $content_index, 1, $nulls );
+ }
+
+ // Skip inserted blocks.
+ $i += count( $blocks_to_insert );
+ } else {
+ if ( ! empty( $blocks[ $i ]['innerBlocks'] ) ) {
+ $prev_inner_content = $inner_content;
+ $inner_content = $blocks[ $i ]['innerContent'];
+ $blocks[ $i ]['innerBlocks'] = resolve_pattern_blocks(
+ $blocks[ $i ]['innerBlocks']
+ );
+ $blocks[ $i ]['innerContent'] = $inner_content;
+ $inner_content = $prev_inner_content;
+ }
+ ++$i;
+ }
+ }
+ return $blocks;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Given an array of parsed block trees, applies callbacks before and after serializing them and
</span><span class="cx" style="display: block; padding: 0 10px"> * returns their concatenated output.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre></div>
<a id="trunksrcwpincludesrestapiendpointsclasswprestblockpatternscontrollerphp"></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/rest-api/endpoints/class-wp-rest-block-patterns-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php 2024-06-03 17:36:35 UTC (rev 58302)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php 2024-06-03 18:30:02 UTC (rev 58303)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -162,6 +162,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function prepare_item_for_response( $item, $request ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Resolve pattern blocks so they don't need to be resolved client-side
+ // in the editor, improving performance.
+ $blocks = parse_blocks( $item['content'] );
+ $blocks = resolve_pattern_blocks( $blocks );
+ $item['content'] = serialize_blocks( $blocks );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $fields = $this->get_fields_for_response( $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $keys = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'name' => 'name',
</span></span></pre></div>
<a id="trunksrcwpincludesrestapiendpointsclasswpresttemplatescontrollerphp"></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/rest-api/endpoints/class-wp-rest-templates-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php 2024-06-03 17:36:35 UTC (rev 58302)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php 2024-06-03 18:30:02 UTC (rev 58303)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -668,6 +668,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return WP_REST_Response Response object.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function prepare_item_for_response( $item, $request ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Resolve pattern blocks so they don't need to be resolved client-side
+ // in the editor, improving performance.
+ $blocks = parse_blocks( $item->content );
+ $blocks = resolve_pattern_blocks( $blocks );
+ $item->content = serialize_blocks( $blocks );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Restores the more descriptive, specific name for use within this method.
</span><span class="cx" style="display: block; padding: 0 10px"> $template = $item;
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestsblocksresolvePatternBlocksphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/blocks/resolvePatternBlocks.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/blocks/resolvePatternBlocks.php (rev 0)
+++ trunk/tests/phpunit/tests/blocks/resolvePatternBlocks.php 2024-06-03 18:30:02 UTC (rev 58303)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,72 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Tests for resolve_pattern_blocks.
+ *
+ * @package WordPress
+ * @subpackage Blocks
+ *
+ * @since 6.6.0
+ *
+ * @group blocks
+ * @covers resolve_pattern_blocks
+ */
+class Tests_Blocks_ResolvePatternBlocks extends WP_UnitTestCase {
+ public function set_up() {
+ parent::set_up();
+
+ register_block_pattern(
+ 'core/test',
+ array(
+ 'title' => 'Test',
+ 'content' => '<!-- wp:paragraph -->Hello<!-- /wp:paragraph --><!-- wp:paragraph -->World<!-- /wp:paragraph -->',
+ 'description' => 'Test pattern.',
+ )
+ );
+ register_block_pattern(
+ 'core/recursive',
+ array(
+ 'title' => 'Recursive',
+ 'content' => '<!-- wp:paragraph -->Recursive<!-- /wp:paragraph --><!-- wp:pattern {"slug":"core/recursive"} /-->',
+ 'description' => 'Recursive pattern.',
+ )
+ );
+ }
+
+ public function tear_down() {
+ unregister_block_pattern( 'core/test' );
+ unregister_block_pattern( 'core/recursive' );
+
+ parent::tear_down();
+ }
+
+ /**
+ * @dataProvider data_should_resolve_pattern_blocks_as_expected
+ *
+ * @ticket 61228
+ *
+ * @param string $blocks A string representing blocks that need resolving.
+ * @param string $expected Expected result.
+ */
+ public function test_should_resolve_pattern_blocks_as_expected( $blocks, $expected ) {
+ $actual = resolve_pattern_blocks( parse_blocks( $blocks ) );
+ $this->assertSame( $expected, serialize_blocks( $actual ) );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_should_resolve_pattern_blocks_as_expected() {
+ return array(
+ // Works without attributes, leaves the block as is.
+ 'pattern with no slug attribute' => array( '<!-- wp:pattern /-->', '<!-- wp:pattern /-->' ),
+ // Resolves the pattern.
+ 'test pattern' => array( '<!-- wp:pattern {"slug":"core/test"} /-->', '<!-- wp:paragraph -->Hello<!-- /wp:paragraph --><!-- wp:paragraph -->World<!-- /wp:paragraph -->' ),
+ // Skips recursive patterns.
+ 'recursive pattern' => array( '<!-- wp:pattern {"slug":"core/recursive"} /-->', '<!-- wp:paragraph -->Recursive<!-- /wp:paragraph -->' ),
+ // Resolves the pattern within a block.
+ 'pattern within a block' => array( '<!-- wp:group --><!-- wp:paragraph -->Before<!-- /wp:paragraph --><!-- wp:pattern {"slug":"core/test"} /--><!-- wp:paragraph -->After<!-- /wp:paragraph --><!-- /wp:group -->', '<!-- wp:group --><!-- wp:paragraph -->Before<!-- /wp:paragraph --><!-- wp:paragraph -->Hello<!-- /wp:paragraph --><!-- wp:paragraph -->World<!-- /wp:paragraph --><!-- wp:paragraph -->After<!-- /wp:paragraph --><!-- /wp:group -->' ),
+ );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/blocks/resolvePatternBlocks.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>