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

Timestamp:

01/24/2023 02:34:10 PM (4 years 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.

File:

• trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php (modified) (3 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;
         }