<!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>[55125] trunk: Editor: Migrate old to the new pattern categories.</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/55125">55125</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/55125","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>hellofromTonya</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-01-24 14:34:10 +0000 (Tue, 24 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'>Editor: Migrate old to the new pattern categories.
Adds a new non-public `WP_REST_Block_Patterns_Controller::migrate_pattern_categories()` method to automatically migrate existing content's pattern categories to the new ones introduced in <a href="https://core.trac.wordpress.org/changeset/55098">[55098]</a>.
Old to New
`'buttons'` to `'call-to-action'`
`'columns'` to `'text'`
`'query'` to `'posts'`
Reference:
* Part of [https://github.com/WordPress/gutenberg/pull/46144 Gutenberg PR 46144]
Follow-up to <a href="https://core.trac.wordpress.org/changeset/55098">[55098]</a>, <a href="https://core.trac.wordpress.org/changeset/53152">[53152]</a>.
Props ntsekouras, annezazu, jameskoster, joen, hellofromTonya, mcsf, paaljoachim, ryelle.
Fixes <a href="https://core.trac.wordpress.org/ticket/57532">#57532</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<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="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-24 12:56:13 UTC (rev 55124)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php 2023-01-24 14:34:10 UTC (rev 55125)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -25,6 +25,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> private $remote_patterns_loaded;
</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">+ * An array that maps old categories names to new ones.
+ *
+ * @since 6.2.0
+ * @var array
+ */
+ protected static $categories_migration = array(
+ 'buttons' => 'call-to-action',
+ 'columns' => 'text',
+ 'query' => 'posts',
+ );
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Constructs the controller.
</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">@@ -84,6 +96,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Retrieves all block patterns.
</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.2.0 Added migration for old core pattern categories to the new ones.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_REST_Request $request Full details about the request.
</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="lines" style="display: block; padding: 0 10px; color: #888">@@ -101,7 +114,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $response = array();
</span><span class="cx" style="display: block; padding: 0 10px"> $patterns = WP_Block_Patterns_Registry::get_instance()->get_all_registered();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $patterns as $pattern ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $prepared_pattern = $this->prepare_item_for_response( $pattern, $request );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $migrated_pattern = $this->migrate_pattern_categories( $pattern );
+ $prepared_pattern = $this->prepare_item_for_response( $migrated_pattern, $request );
</ins><span class="cx" style="display: block; padding: 0 10px"> $response[] = $this->prepare_response_for_collection( $prepared_pattern );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> return rest_ensure_response( $response );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -108,6 +122,36 @@
</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">+ * Migrates old core pattern categories to the new categories.
+ *
+ * Core pattern categories are revamped. Migration is needed to ensure
+ * backwards compatibility.
+ *
+ * @since 6.2.0
+ *
+ * @param array $pattern Raw pattern as registered, before applying any changes.
+ * @return array Migrated pattern.
+ */
+ protected function migrate_pattern_categories( $pattern ) {
+ // No categories to migrate.
+ if (
+ ! isset( $pattern['categories'] ) ||
+ ! is_array( $pattern['categories'] )
+ ) {
+ return $pattern;
+ }
+
+ foreach ( $pattern['categories'] as $index => $category ) {
+ // If the category exists as a key, then it needs migration.
+ if ( isset( static::$categories_migration[ $category ] ) ) {
+ $pattern['categories'][ $index ] = static::$categories_migration[ $category ];
+ }
+ }
+
+ return $pattern;
+ }
+
+ /**
</ins><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></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-24 12:56:13 UTC (rev 55124)
+++ trunk/tests/phpunit/tests/rest-api/wpRestBlockPatternsController.php 2023-01-24 14:34:10 UTC (rev 55125)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -92,6 +92,15 @@
</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"> )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $test_registry->register(
+ 'test/three',
+ array(
+ 'title' => 'Pattern Three',
+ 'categories' => array( 'test', 'buttons', 'query' ),
+ 'content' => '<!-- wp:paragraph --><p>Three</p><!-- /wp:paragraph -->',
+ )
+ );
</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"> public static function wpTearDownAfterClass() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -172,6 +181,51 @@
</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">+ * Tests the proper migration of old core pattern categories to new ones.
+ *
+ * @since 6.2.0
+ *
+ * @ticket 57532
+ *
+ * @covers WP_REST_Block_Patterns_Controller::get_items
+ */
+ public function test_get_items_migrate_pattern_categories() {
+ wp_set_current_user( self::$admin_id );
+
+ $request = new WP_REST_Request( 'GET', static::REQUEST_ROUTE );
+ $request['_fields'] = 'name,categories';
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+
+ $this->assertIsArray( $data, 'WP_REST_Block_Patterns_Controller::get_items() should return an array' );
+ $this->assertGreaterThanOrEqual( 3, count( $data ), 'WP_REST_Block_Patterns_Controller::get_items() should return at least 3 items' );
+ $this->assertSame(
+ array(
+ 'name' => 'test/one',
+ 'categories' => array( 'test' ),
+ ),
+ $data[0],
+ 'WP_REST_Block_Patterns_Controller::get_items() should return test/one'
+ );
+ $this->assertSame(
+ array(
+ 'name' => 'test/two',
+ 'categories' => array( 'test' ),
+ ),
+ $data[1],
+ 'WP_REST_Block_Patterns_Controller::get_items() should return test/two'
+ );
+ $this->assertSame(
+ array(
+ 'name' => 'test/three',
+ 'categories' => array( 'test', 'call-to-action', 'posts' ),
+ ),
+ $data[2],
+ 'WP_REST_Block_Patterns_Controller::get_items() should return test/three'
+ );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @doesNotPerformAssertions
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_context_param() {
</span></span></pre>
</div>
</div>
</body>
</html>