Changeset 49966

Timestamp:

01/17/2021 12:49:39 AM (4 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Allow sending an empty array to delete multi meta keys.

Previously, only null was supported.

Fixes #50790.
Props chrisvanpatten.

Location:

trunk

Files:

• src/wp-includes/rest-api/fields/class-wp-rest-meta-fields.php (modified) (2 diffs)
• 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

@@ -146 +146 @@
             }
 
+            $value = $meta[ $name ];
+
             /*
              * A null value means reset the field, which is essentially deleting it
              * from the database and then relying on the default value.
+             *
+             * Non-single meta can also be removed by passing an empty array.
              */
-            if ( is_null( $meta[ $name ] ) ) {
+            if ( is_null( $value ) || ( array() === $value && ! $args['single'] ) ) {
                 $args = $this->get_registered_fields()[ $meta_key ];
 
@@ -172 +176 @@
                 continue;
             }
-
-            $value = $meta[ $name ];
 
             if ( ! $args['single'] && is_array( $value ) && count( array_filter( $value, 'is_null' ) ) ) {

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

@@ -1026 +1026 @@
         $post_updated = get_post( self::$post_id );
         $this->assertSame( $post_original->post_content, $post_updated->post_content );
+    }
+
+    /**
+     * @ticket 50790
+     */
+    public function test_remove_multi_value_with_empty_array() {
+        add_post_meta( self::$post_id, 'test_multi', 'val1' );
+        $values = get_post_meta( self::$post_id, 'test_multi', false );
+        $this->assertSame( array( 'val1' ), $values );
+
+        $this->grant_write_permission();
+
+        $data    = array(
+            'meta' => array(
+                'test_multi' => array(),
+            ),
+        );
+        $request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/posts/%d', self::$post_id ) );
+        $request->set_body_params( $data );
+
+        $response = rest_get_server()->dispatch( $request );
+        $this->assertSame( 200, $response->get_status() );
+
+        $meta = get_post_meta( self::$post_id, 'test_multi', false );
+        $this->assertEmpty( $meta );
     }