Changeset 55125

Timestamp:

01/24/2023 02:34:10 PM (20 months ago)

Author:

hellofromTonya

Message:

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 [55098].

Old to New
'buttons' to 'call-to-action'
'columns' to 'text'
'query' to 'posts'

Reference:

• Part of ​Gutenberg PR 46144

Follow-up to [55098], [53152].

Props ntsekouras, annezazu, jameskoster, joen, hellofromTonya, mcsf, paaljoachim, ryelle.
Fixes #57532.

Location:

trunk

Files:

• src/wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php (modified) (3 diffs)
• tests/phpunit/tests/rest-api/wpRestBlockPatternsController.php (modified) (2 diffs)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php

@@ -24 +24 @@
      */
     private $remote_patterns_loaded;
+
+    /**
+     * 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',
+    );
 
     /**
@@ -85 +97 @@
      *
      * @since 6.0.0
+     * @since 6.2.0 Added migration for old core pattern categories to the new ones.
      *
      * @param WP_REST_Request $request Full details about the request.
@@ -102 +115 @@
         $patterns = WP_Block_Patterns_Registry::get_instance()->get_all_registered();
         foreach ( $patterns as $pattern ) {
-            $prepared_pattern = $this->prepare_item_for_response( $pattern, $request );
+            $migrated_pattern = $this->migrate_pattern_categories( $pattern );
+            $prepared_pattern = $this->prepare_item_for_response( $migrated_pattern, $request );
             $response[]       = $this->prepare_response_for_collection( $prepared_pattern );
         }
         return rest_ensure_response( $response );
+    }
+
+    /**
+     * 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;
     }
 

trunk/tests/phpunit/tests/rest-api/wpRestBlockPatternsController.php

@@ -93 +93 @@
             )
         );
+
+        $test_registry->register(
+            'test/three',
+            array(
+                'title'      => 'Pattern Three',
+                'categories' => array( 'test', 'buttons', 'query' ),
+                'content'    => '<!-- wp:paragraph --><p>Three</p><!-- /wp:paragraph -->',
+            )
+        );
     }
 
@@ -173 +182 @@
 
     /**
+     * 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'
+        );
+    }
+
+    /**
      * @doesNotPerformAssertions
      */