<!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>[56063] trunk: Editor: allow filtering block patterns by source.</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/56063">56063</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/56063","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>isabel_brison</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-06-27 11:11:02 +0000 (Tue, 27 Jun 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'>Editor: allow filtering block patterns by source.
Extends the REST API endpoint for block patterns to provide a source attribute that can be used to filter patterns.
Props aaronrobertshaw, mukesh27, talldanwp, ramonopoly.
Fixes 58622.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesblockpatternsphp">trunk/src/wp-includes/block-patterns.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="#trunktestsphpunittestsrestapiwpRestBlockPatternsControllerphp">trunk/tests/phpunit/tests/rest-api/wpRestBlockPatternsController.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesblockpatternsphp"></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/block-patterns.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/block-patterns.php 2023-06-27 10:43:32 UTC (rev 56062)
+++ trunk/src/wp-includes/block-patterns.php 2023-06-27 11:11:02 UTC (rev 56063)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -12,6 +12,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Registers the core block patterns and categories.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.3.0 Added source to core block patterns.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function _register_core_block_patterns_and_categories() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -29,10 +30,9 @@
</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"> foreach ( $core_block_patterns as $core_block_pattern ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- register_block_pattern(
- 'core/' . $core_block_pattern,
- require __DIR__ . '/block-patterns/' . $core_block_pattern . '.php'
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $pattern = require __DIR__ . '/block-patterns/' . $core_block_pattern . '.php';
+ $pattern['source'] = 'core';
+ register_block_pattern( 'core/' . $core_block_pattern, $pattern );
</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">@@ -190,6 +190,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.9.0 The $current_screen argument was removed.
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.2.0 Normalize the pattern from the API (snake_case) to the
</span><span class="cx" style="display: block; padding: 0 10px"> * format expected by `register_block_pattern` (camelCase).
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.3.0 Add 'pattern-directory/core' to the pattern's 'source'.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Screen $deprecated Unused. Formerly the screen that the current request was triggered from.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -224,6 +225,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $patterns = $response->get_data();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $patterns as $pattern ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $pattern['source'] = 'pattern-directory/core';
</ins><span class="cx" style="display: block; padding: 0 10px"> $normalized_pattern = wp_normalize_remote_block_pattern( $pattern );
</span><span class="cx" style="display: block; padding: 0 10px"> $pattern_name = 'core/' . sanitize_title( $normalized_pattern['title'] );
</span><span class="cx" style="display: block; padding: 0 10px"> register_block_pattern( $pattern_name, $normalized_pattern );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -237,6 +239,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.2.0 Normalized the pattern from the API (snake_case) to the
</span><span class="cx" style="display: block; padding: 0 10px"> * format expected by `register_block_pattern()` (camelCase).
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.3.0 Add 'pattern-directory/featured' to the pattern's 'source'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function _load_remote_featured_patterns() {
</span><span class="cx" style="display: block; padding: 0 10px"> $supports_core_patterns = get_theme_support( 'core-block-patterns' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -258,6 +261,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $patterns = $response->get_data();
</span><span class="cx" style="display: block; padding: 0 10px"> $registry = WP_Block_Patterns_Registry::get_instance();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $patterns as $pattern ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $pattern['source'] = 'pattern-directory/featured';
</ins><span class="cx" style="display: block; padding: 0 10px"> $normalized_pattern = wp_normalize_remote_block_pattern( $pattern );
</span><span class="cx" style="display: block; padding: 0 10px"> $pattern_name = sanitize_title( $normalized_pattern['title'] );
</span><span class="cx" style="display: block; padding: 0 10px"> // Some patterns might be already registered as core patterns with the `core` prefix.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -275,6 +279,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.2.0 Normalized the pattern from the API (snake_case) to the
</span><span class="cx" style="display: block; padding: 0 10px"> * format expected by `register_block_pattern()` (camelCase).
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.3.0 Add 'pattern-directory/theme' to the pattern's 'source'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function _register_remote_theme_patterns() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -301,6 +306,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $patterns = $response->get_data();
</span><span class="cx" style="display: block; padding: 0 10px"> $patterns_registry = WP_Block_Patterns_Registry::get_instance();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $patterns as $pattern ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $pattern['source'] = 'pattern-directory/theme';
</ins><span class="cx" style="display: block; padding: 0 10px"> $normalized_pattern = wp_normalize_remote_block_pattern( $pattern );
</span><span class="cx" style="display: block; padding: 0 10px"> $pattern_name = sanitize_title( $normalized_pattern['title'] );
</span><span class="cx" style="display: block; padding: 0 10px"> // Some patterns might be already registered as core patterns with the `core` prefix.
</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 2023-06-27 10:43:32 UTC (rev 56062)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php 2023-06-27 11:11:02 UTC (rev 56063)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -155,6 +155,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Prepare a raw block pattern before it gets output in a REST API response.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.0.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.3.0 Added `source` property.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $item Raw pattern as registered, before any changes.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_REST_Request $request Request object.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -174,6 +175,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'blockTypes' => 'block_types',
</span><span class="cx" style="display: block; padding: 0 10px"> 'postTypes' => 'post_types',
</span><span class="cx" style="display: block; padding: 0 10px"> 'templateTypes' => 'template_types',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'source' => 'source',
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> $data = array();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $keys as $item_key => $rest_key ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -192,6 +194,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Retrieves the block pattern schema, conforming to JSON Schema.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.0.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.3.0 Added `source` property.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array Item schema data.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -267,6 +270,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'readonly' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'context' => array( 'view', 'edit', 'embed' ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'source' => array(
+ 'description' => __( 'Where the pattern comes from e.g. core' ),
+ 'type' => 'string',
+ 'readonly' => true,
+ 'context' => array( 'view', 'edit', 'embed' ),
+ 'enum' => array(
+ 'core',
+ 'plugin',
+ 'theme',
+ 'pattern-directory/core',
+ 'pattern-directory/theme',
+ 'pattern-directory/featured',
+ ),
+ ),
</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="trunktestsphpunittestsrestapiwpRestBlockPatternsControllerphp"></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/rest-api/wpRestBlockPatternsController.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/wpRestBlockPatternsController.php 2023-06-27 10:43:32 UTC (rev 56062)
+++ trunk/tests/phpunit/tests/rest-api/wpRestBlockPatternsController.php 2023-06-27 11:11:02 UTC (rev 56063)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -76,6 +76,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'viewportWidth' => 1440,
</span><span class="cx" style="display: block; padding: 0 10px"> 'categories' => array( 'test' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'templateTypes' => array( 'page' ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'source' => 'theme',
</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">@@ -86,6 +87,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'content' => '<!-- wp:paragraph --><p>Two</p><!-- /wp:paragraph -->',
</span><span class="cx" style="display: block; padding: 0 10px"> 'categories' => array( 'test' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'templateTypes' => array( 'single' ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'source' => 'core',
</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">@@ -95,6 +97,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'title' => 'Pattern Three',
</span><span class="cx" style="display: block; padding: 0 10px"> 'content' => '<!-- wp:paragraph --><p>Three</p><!-- /wp:paragraph -->',
</span><span class="cx" style="display: block; padding: 0 10px"> 'categories' => array( 'test', 'buttons', 'query' ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'source' => 'pattern-directory/featured',
</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">@@ -124,7 +127,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp_set_current_user( self::$admin_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'GET', static::REQUEST_ROUTE );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $request['_fields'] = 'name,content,template_types';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $request['_fields'] = 'name,content,source,template_types';
</ins><span class="cx" style="display: block; padding: 0 10px"> $response = rest_get_server()->dispatch( $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $data = $response->get_data();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -135,6 +138,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'name' => 'test/one',
</span><span class="cx" style="display: block; padding: 0 10px"> 'content' => '<!-- wp:heading {"level":1} --><h1>One</h1><!-- /wp:heading -->',
</span><span class="cx" style="display: block; padding: 0 10px"> 'template_types' => array( 'page' ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'source' => 'theme',
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> $data[0],
</span><span class="cx" style="display: block; padding: 0 10px"> 'WP_REST_Block_Patterns_Controller::get_items() should return test/one'
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -144,6 +148,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'name' => 'test/two',
</span><span class="cx" style="display: block; padding: 0 10px"> 'content' => '<!-- wp:paragraph --><p>Two</p><!-- /wp:paragraph -->',
</span><span class="cx" style="display: block; padding: 0 10px"> 'template_types' => array( 'single' ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'source' => 'core',
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> $data[1],
</span><span class="cx" style="display: block; padding: 0 10px"> 'WP_REST_Block_Patterns_Controller::get_items() should return test/two'
</span></span></pre>
</div>
</div>
</body>
</html>