Changeset 48642

Timestamp:

07/27/2020 06:44:14 PM (4 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Fix warning when using set_param() on a JSON request with no body.

In [47559] the WP_REST_Request::set_param() method was adjusted to try and overwrite an existing parameter definition before forcing the value in the first parameter slot. If set_param() was called on a request with an application/json content type and an empty body, a PHP warning would be issued. This was due to the JSON parameter type not being set to an array when the body is empty.

This commit avoids the warning by adding an is_array() check before calling array_key_exists. Ideally, WP_REST_Reuest::parse_json_params() would set the JSON parameter type to an empty array in this case, but that is too large of a change at this point in the cycle.

Props manooweb.
Fixes #50786.

Location:

trunk

Files:

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

trunk/src/wp-includes/rest-api/class-wp-rest-request.php

@@ -409 +409 @@
 
         foreach ( $order as $type ) {
-            if ( array_key_exists( $key, $this->params[ $type ] ) ) {
+            if ( is_array( $this->params[ $type ] ) && array_key_exists( $key, $this->params[ $type ] ) ) {
                 return true;
             }
@@ -434 +434 @@
 
         foreach ( $order as $type ) {
-            if ( 'defaults' !== $type && array_key_exists( $key, $this->params[ $type ] ) ) {
+            if ( 'defaults' !== $type && is_array( $this->params[ $type ] ) && array_key_exists( $key, $this->params[ $type ] ) ) {
                 $this->params[ $type ][ $key ] = $value;
                 $found_key                     = true;

trunk/tests/phpunit/tests/rest-api/rest-request.php

@@ -766 +766 @@
         $this->assertEquals( array( 'param' => 'new_value' ), $request->get_query_params() );
     }
+
+    /**
+     * @ticket 50786
+     */
+    public function test_set_param_with_invalid_json() {
+        $request = new WP_REST_Request();
+        $request->add_header( 'content-type', 'application/json' );
+        $request->set_method( 'POST' );
+        $request->set_body( '' );
+        $request->set_param( 'param', 'value' );
+
+        $this->assertTrue( $request->has_param( 'param' ) );
+        $this->assertEquals( 'value', $request->get_param( 'param' ) );
+    }
 }