Changeset 45903

Timestamp:

08/28/2019 03:07:03 AM (5 years ago)

Author:

kadamwhite

Message:

REST API: Only cast scalar types to string when comparing new & old meta values.

Newly-supported array and object meta types should not be cast to strings.

Props TimothyBlynJacobs, caercam.
Fixes #47928.

Location:

trunk

Files:

• src/wp-includes/rest-api/fields/class-wp-rest-meta-fields.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-post-meta-fields.php (modified) (1 diff)

trunk/src/wp-includes/rest-api/fields/class-wp-rest-meta-fields.php

@@ -351 +351 @@
         $old_value = get_metadata( $meta_type, $object_id, $meta_key );
         $subtype   = get_object_subtype( $meta_type, $object_id );
+        $args      = $this->get_registered_fields()[ $meta_key ];
 
         if ( 1 === count( $old_value ) ) {
-            if ( (string) sanitize_meta( $meta_key, $value, $meta_type, $subtype ) === $old_value[0] ) {
+            $sanitized = sanitize_meta( $meta_key, $value, $meta_type, $subtype );
+
+            if ( in_array( $args['type'], array( 'string', 'number', 'integer', 'boolean' ), true ) ) {
+                // The return value of get_metadata will always be a string for scalar types.
+                $sanitized = (string) $sanitized;
+            }
+
+            if ( $sanitized === $old_value[0] ) {
                 return true;
             }

trunk/tests/phpunit/tests/rest-api/rest-post-meta-fields.php

@@ -2122 +2122 @@
 
     /**
+     * @ticket 47928
+     */
+    public function test_update_meta_with_unchanged_array_values() {
+        register_post_meta(
+            'post',
+            'list',
+            array(
+                'single'       => true,
+                'type'         => 'array',
+                'show_in_rest' => array(
+                    'schema' => array(
+                        'type'  => 'array',
+                        'items' => array(
+                            'type' => 'string',
+                        ),
+                    ),
+                ),
+            )
+        );
+
+        add_post_meta( self::$post_id, 'list', array( 'WordCamp' ) );
+
+        $this->grant_write_permission();
+
+        $request = new WP_REST_Request( 'PUT', sprintf( '/wp/v2/posts/%d', self::$post_id ) );
+        $request->set_body_params(
+            array(
+                'meta' => array(
+                    'list' => array( 'WordCamp' ),
+                ),
+            )
+        );
+
+        $response = rest_get_server()->dispatch( $request );
+        $this->assertEquals( 200, $response->get_status() );
+
+        $data = $response->get_data();
+        $this->assertEquals( array( 'WordCamp' ), $data['meta']['list'] );
+    }
+
+    /**
+     * @ticket 47928
+     */
+    public function test_update_meta_with_unchanged_object_values() {
+        register_post_meta(
+            'post',
+            'object',
+            array(
+                'single'       => true,
+                'type'         => 'object',
+                'show_in_rest' => array(
+                    'schema' => array(
+                        'type'       => 'object',
+                        'properties' => array(
+                            'project' => array(
+                                'type' => 'string',
+                            ),
+                        ),
+                    ),
+                ),
+            )
+        );
+
+        add_post_meta( self::$post_id, 'object', array( 'project' => 'WordCamp' ) );
+
+        $this->grant_write_permission();
+
+        $request = new WP_REST_Request( 'PUT', sprintf( '/wp/v2/posts/%d', self::$post_id ) );
+        $request->set_body_params(
+            array(
+                'meta' => array(
+                    'object' => array( 'project' => 'WordCamp' ),
+                ),
+            )
+        );
+
+        $response = rest_get_server()->dispatch( $request );
+        $this->assertEquals( 200, $response->get_status() );
+
+        $data = $response->get_data();
+        $this->assertEquals( array( 'project' => 'WordCamp' ), $data['meta']['object'] );
+    }
+
+    /**
      * Internal function used to disable an insert query which
      * will trigger a wpdb error for testing purposes.