From 2bcd6390b2d0f52c1f85cb42bcd1b10d7c382ef5 Mon Sep 17 00:00:00 2001 From: Tonya Mork Date: Tue, 24 Jan 2023 14:34:10 +0000 Subject: [PATCH] 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 [https://github.com/WordPress/gutenberg/pull/46144 Gutenberg PR 46144] Follow-up to [55098], [53152]. Props ntsekouras, annezazu, jameskoster, joen, hellofromTonya, mcsf, paaljoachim, ryelle. Fixes #57532. git-svn-id: https://develop.svn.wordpress.org/trunk@55125 602fd350-edb4-49c9-b593-d223f7449a82 --- ...lass-wp-rest-block-patterns-controller.php | 46 +++++++++++++++- .../wpRestBlockPatternsController.php | 54 +++++++++++++++++++ 2 files changed, 99 insertions(+), 1 deletion(-) diff --git a/src/wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php b/src/wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php index cb0fe57fed..adc4a0aade 100644 --- a/src/wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php +++ b/src/wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php @@ -24,6 +24,18 @@ class WP_REST_Block_Patterns_Controller extends WP_REST_Controller { */ 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', + ); + /** * Constructs the controller. * @@ -84,6 +96,7 @@ class WP_REST_Block_Patterns_Controller extends WP_REST_Controller { * Retrieves all block patterns. * * @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. * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. @@ -101,12 +114,43 @@ class WP_REST_Block_Patterns_Controller extends WP_REST_Controller { $response = array(); $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; + } + /** * Prepare a raw block pattern before it gets output in a REST API response. * diff --git a/tests/phpunit/tests/rest-api/wpRestBlockPatternsController.php b/tests/phpunit/tests/rest-api/wpRestBlockPatternsController.php index f49c658ae5..3229f2f38d 100644 --- a/tests/phpunit/tests/rest-api/wpRestBlockPatternsController.php +++ b/tests/phpunit/tests/rest-api/wpRestBlockPatternsController.php @@ -92,6 +92,15 @@ class Tests_REST_WpRestBlockPatternsController extends WP_Test_REST_Controller_T 'content' => '

Two

', ) ); + + $test_registry->register( + 'test/three', + array( + 'title' => 'Pattern Three', + 'categories' => array( 'test', 'buttons', 'query' ), + 'content' => '

Three

', + ) + ); } public static function wpTearDownAfterClass() { @@ -171,6 +180,51 @@ class Tests_REST_WpRestBlockPatternsController extends WP_Test_REST_Controller_T $this->assertSame( 403, $response->get_status() ); } + /** + * 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 */