<!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>[55168] trunk: Add: Template types to the patterns API.</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/55168">55168</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/55168","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>jorgefilipecosta</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-01-31 16:47:58 +0000 (Tue, 31 Jan 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'>Add: Template types to the patterns API.
Backports https://github.com/WordPress/gutenberg/pull/45814 into the core.
This commit adds a new templateType property to the patterns registration API.
This property allows a pattern to specify which template it makes sense on, e.g.: 404, single-post, single-product, category.
Props youknowriad, ntsekouras,
spacedmonkey.</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-01-31 15:22:33 UTC (rev 55167)
+++ trunk/src/wp-includes/block-patterns.php 2023-01-31 16:47:58 UTC (rev 55168)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -302,6 +302,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * - Keywords (comma-separated values)
</span><span class="cx" style="display: block; padding: 0 10px"> * - Block Types (comma-separated values)
</span><span class="cx" style="display: block; padding: 0 10px"> * - Post Types (comma-separated values)
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * - Template Types (comma-separated values)
</ins><span class="cx" style="display: block; padding: 0 10px"> * - Inserter (yes/no)
</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><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -318,6 +319,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"> 'inserter' => 'Inserter',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'templateTypes' => 'Template Types',
</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">@@ -388,7 +390,7 @@
</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"> // For properties of type array, parse data as comma-separated.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( array( 'categories', 'keywords', 'blockTypes', 'postTypes' ) as $property ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( array( 'categories', 'keywords', 'blockTypes', 'postTypes', 'templateTypes' ) as $property ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $pattern_data[ $property ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $pattern_data[ $property ] = array_filter(
</span><span class="cx" style="display: block; padding: 0 10px"> preg_split(
</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-01-31 15:22:33 UTC (rev 55167)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php 2023-01-31 16:47:58 UTC (rev 55168)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -173,6 +173,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'keywords' => 'keywords',
</span><span class="cx" style="display: block; padding: 0 10px"> 'content' => 'content',
</span><span class="cx" style="display: block; padding: 0 10px"> 'inserter' => 'inserter',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'templateTypes' => 'template_types',
</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">@@ -248,6 +249,12 @@
</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">+ 'template_types' => array(
+ 'description' => __( 'An array of template types where the pattern fits.' ),
+ 'type' => 'array',
+ 'readonly' => true,
+ 'context' => array( 'view', 'edit', 'embed' ),
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'content' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => __( 'The pattern content.' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'string',
</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-01-31 15:22:33 UTC (rev 55167)
+++ trunk/tests/phpunit/tests/rest-api/wpRestBlockPatternsController.php 2023-01-31 16:47:58 UTC (rev 55168)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -81,6 +81,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'categories' => array( 'test' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'viewportWidth' => 1440,
</span><span class="cx" style="display: block; padding: 0 10px"> 'content' => '<!-- wp:heading {"level":1} --><h1>One</h1><!-- /wp:heading -->',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'templateTypes' => array( 'page' ),
</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">@@ -87,9 +88,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $test_registry->register(
</span><span class="cx" style="display: block; padding: 0 10px"> 'test/two',
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'title' => 'Pattern Two',
- 'categories' => array( 'test' ),
- 'content' => '<!-- wp:paragraph --><p>Two</p><!-- /wp:paragraph -->',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'title' => 'Pattern Two',
+ 'categories' => array( 'test' ),
+ 'content' => '<!-- wp:paragraph --><p>Two</p><!-- /wp:paragraph -->',
+ 'templateTypes' => array( 'single' ),
</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">@@ -128,7 +130,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';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $request['_fields'] = 'name,content,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">@@ -136,8 +138,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertGreaterThanOrEqual( 2, count( $data ), 'WP_REST_Block_Patterns_Controller::get_items() should return at least 2 items' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'name' => 'test/one',
- 'content' => '<!-- wp:heading {"level":1} --><h1>One</h1><!-- /wp:heading -->',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'name' => 'test/one',
+ 'content' => '<!-- wp:heading {"level":1} --><h1>One</h1><!-- /wp:heading -->',
+ 'template_types' => array( 'page' ),
</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,8 +147,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'name' => 'test/two',
- 'content' => '<!-- wp:paragraph --><p>Two</p><!-- /wp:paragraph -->',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'name' => 'test/two',
+ 'content' => '<!-- wp:paragraph --><p>Two</p><!-- /wp:paragraph -->',
+ 'template_types' => array( 'single' ),
</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>