Changeset 35890

Timestamp:

12/12/2015 06:22:02 PM (11 years ago)

Author:

joehoyle

Message:

REST API: Improve formatting of failed validation errors.

If a validation_callback returns a WP_Error it should give the same response format as if it returned false. This makes programmatically reading the validation errors better.

Props bradyvercher for initial patch.
Fixes #35028.

Location:

trunk

Files:

• .gitignore (modified) (1 diff)
• 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/.gitignore

@@ -1 +1 @@
 # gitignore file for WordPress Core
-
+.svn
 # Configuration files with possibly sensitive information
 wp-config.php

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

@@ -852 +852 @@
 
                                 if ( is_wp_error( $valid_check ) ) {
-                                        $invalid_params[] = sprintf( '%s (%s)', $key, $valid_check->get_error_message() );
+                                        $invalid_params[ $key ] = $valid_check->get_error_message();
                                 }
                         }
@@ -858 +858 @@
 
                 if ( $invalid_params ) {
-                        return new WP_Error( 'rest_invalid_param', sprintf( __( 'Invalid parameter(s): %s' ), implode( ', ', $invalid_params ) ), array( 'status' => 400, 'params' => $invalid_params ) );
+                        return new WP_Error( 'rest_invalid_param', sprintf( __( 'Invalid parameter(s): %s' ), implode( ', ', array_keys( $invalid_params ) ) ), array( 'status' => 400, 'params' => $invalid_params ) );
                 }
 

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

@@ -392 +392 @@
                 $this->assertArrayHasKey( 'someotherinteger', $data['params'] );
         }
+
+        public function test_invalid_params_error_response_format() {
+                $this->request->set_url_params( array(
+                        'someinteger' => '123',
+                        'someotherparams' => '123',
+                ));
+
+                $this->request->set_attributes( array(
+                        'args' => array(
+                                'someinteger' => array(
+                                        'validate_callback' => '__return_false',
+                                ),
+                                'someotherparams' => array(
+                                        'validate_callback' => array( $this, '_return_wp_error_on_validate_callback' ),
+                                ),
+                        ),
+                ));
+
+                $valid = $this->request->has_valid_params();
+                $this->assertWPError( $valid );
+                $error_data = $valid->get_error_data();
+
+                $this->assertEquals( array( 'someinteger', 'someotherparams' ), array_keys( $error_data['params'] ) );
+                $this->assertEquals( 'This is not valid!', $error_data['params']['someotherparams'] );
+        }
+
+        public function _return_wp_error_on_validate_callback() {
+                return new WP_Error( 'some-error', 'This is not valid!' );
+        }
 }