Changeset 56160

Timestamp:

07/07/2023 07:27:53 AM (19 months ago)

Author:

isabel_brison

Message:

Editor: rename sync_status and move it to top level.

Renames sync_status to wp_pattern_sync_status and moves it to top level field of wp_block post type.

Props glendaviesnz, aaronrobertshaw, mukesh27, peterwilsoncc.
Fixes 58677.

Location:

trunk

Files:

• src/wp-includes/post.php (modified) (2 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-blocks-controller.php (modified) (2 diffs)
• tests/phpunit/tests/rest-api/rest-blocks-controller.php (modified) (1 diff)

trunk/src/wp-includes/post.php

@@ -8042 +8042 @@
  * Registers any additional post meta fields.
  *
- * @since 6.3.0 Adds sync_status meta field to the wp_block post type so an unsynced option can be added.
+ * @since 6.3.0 Adds `wp_pattern_sync_status` meta field to the wp_block post type so an unsynced option can be added.
  *
  * @link https://github.com/WordPress/gutenberg/pull/51144
@@ -8049 +8049 @@
     register_post_meta(
         'wp_block',
-        'sync_status',
+        'wp_pattern_sync_status',
         array(
             'sanitize_callback' => 'sanitize_text_field',

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

@@ -41 +41 @@
      *
      * @since 5.0.0
+     * @since 6.3 Adds the `wp_pattern_sync_status` postmeta property to the top level of response.
      *
      * @param array  $data    Response data to filter.
@@ -57 +58 @@
         unset( $data['content']['rendered'] );
 
+        // Add the core wp_pattern_sync_status meta as top level property to the response.
+        $data['wp_pattern_sync_status'] = isset( $data['meta']['wp_pattern_sync_status'] ) ? $data['meta']['wp_pattern_sync_status'] : '';
+        unset( $data['meta']['wp_pattern_sync_status'] );
         return $data;
     }

trunk/tests/phpunit/tests/rest-api/rest-blocks-controller.php

@@ -221 +221 @@
         );
     }
+
+    /**
+     * Check that the `wp_pattern_sync_status` postmeta is moved from meta array to top
+     * level of response.
+     *
+     * @ticket 58677
+     */
+    public function test_wp_patterns_sync_status_post_meta() {
+        register_post_meta(
+            'wp_block',
+            'wp_pattern_sync_status',
+            array(
+                'single'       => true,
+                'type'         => 'string',
+                'show_in_rest' => array(
+                    'schema' => array(
+                        'type'       => 'string',
+                        'properties' => array(
+                            'sync_status' => array(
+                                'type' => 'string',
+                            ),
+                        ),
+                    ),
+                ),
+            )
+        );
+        wp_set_current_user( self::$user_ids['author'] );
+
+        $request  = new WP_REST_Request( 'GET', '/wp/v2/blocks/' . self::$post_id );
+        $response = rest_get_server()->dispatch( $request );
+        $data     = $response->get_data();
+
+        $this->assertArrayHasKey( 'wp_pattern_sync_status', $data );
+        $this->assertArrayNotHasKey( 'wp_pattern_sync_status', $data['meta'] );
+    }
 }