Changeset 50793

Timestamp:

04/27/2021 06:34:52 PM (2 years ago)

Author:

SergeyBiryukov

Message:

REST API: Check the results of get_metadata() in WP_REST_Meta_Fields methods.

This avoids PHP warnings in case the function returns boolean false instead of an array.

Props david.binda.
Fixes #53099.

Location:

trunk

Files:

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

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

@@ -95 +95 @@
                 $value = array();
 
-                foreach ( $all_values as $row ) {
-                    $value[] = $this->prepare_value_for_response( $row, $request, $args );
+                if ( is_array( $all_values ) ) {
+                    foreach ( $all_values as $row ) {
+                        $value[] = $this->prepare_value_for_response( $row, $request, $args );
+                    }
                 }
             }
@@ -281 +283 @@
         $current_values = get_metadata( $meta_type, $object_id, $meta_key, false );
         $subtype        = get_object_subtype( $meta_type, $object_id );
+
+        if ( ! is_array( $current_values ) ) {
+            $current_values = array();
+        }
 
         $to_remove = $current_values;
@@ -378 +384 @@
         $subtype   = get_object_subtype( $meta_type, $object_id );
 
-        if ( 1 === count( $old_value ) && $this->is_meta_value_same_as_stored_value( $meta_key, $subtype, $old_value[0], $value ) ) {
+        if ( is_array( $old_value ) && 1 === count( $old_value )
+            && $this->is_meta_value_same_as_stored_value( $meta_key, $subtype, $old_value[0], $value )
+        ) {
             return true;
         }

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

@@ -1287 +1287 @@
 
     /**
+     * @ticket 53099
+     */
+    public function test_get_term_metadata_returning_false_does_not_cause_php_warnings() {
+        add_filter( 'get_term_metadata', '__return_false', 11 );
+
+        // No PHP warning during GET request.
+        add_term_meta( self::$category_id, 'test_single', 'testvalue' );
+        $request  = new WP_REST_Request( 'GET', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
+        $response = rest_get_server()->dispatch( $request );
+
+        // No PHP warning during POST request.
+        $this->grant_write_permission();
+        $data    = array(
+            'meta' => array(
+                'test_multi' => array( 'val1' ),
+            ),
+        );
+        $request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
+        $request->set_body_params( $data );
+        $response = rest_get_server()->dispatch( $request );
+
+        // No PHP warning during validation.
+        register_meta(
+            'term',
+            'my_meta_key',
+            array(
+                'show_in_rest' => true,
+                'single'       => true,
+                'type'         => 'integer',
+            )
+        );
+        $this->grant_write_permission();
+        $data    = array(
+            'meta' => array(
+                'my_meta_key' => '1', // Set to a string.
+            ),
+        );
+        $request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
+        $request->set_body_params( $data );
+        $response = rest_get_server()->dispatch( $request );
+
+        remove_filter( 'get_term_metadata', '__return_false', 11 );
+
+        $data = $response->get_data();
+        $this->assertSame( 0, $data['meta']['my_meta_key'] );
+    }
+
+    /**
      * Internal function used to disable an insert query which
      * will trigger a wpdb error for testing purposes.