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

Timestamp:

02/02/2021 05:26:06 PM (4 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Return detailed error information from request validation.

Previously, only the first error message for each parameter was made available. Now, all error messages for a parameter are concatenated. Additionally, the detailed error for each parameter is made available in a new details section of the validation error. Each error is formatted following the standard REST API error formatting.

The WP_REST_Server::error_to_response method has been abstracted out into a standalone function rest_convert_error_to_response to allow for reuse by WP_REST_Request. The formatted errors now also contain an additional_data property which contains the additional error data provided by WP_Error::get_all_error_data.

Props dlh, xkon, TimothyBlynJacobs.
Fixes #46191.

File:

• trunk/src/wp-includes/rest-api/class-wp-rest-request.php (modified) (7 diffs)

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

@@ -803 +803 @@
         $order = $this->get_parameter_order();
 
-        $invalid_params = array();
+        $invalid_params  = array();
+        $invalid_details = array();
 
         foreach ( $order as $type ) {
@@ -826 +827 @@
                 }
 
+                /** @var mixed|WP_Error $sanitized_value */
                 $sanitized_value = call_user_func( $param_args['sanitize_callback'], $value, $this, $key );
 
                 if ( is_wp_error( $sanitized_value ) ) {
-                    $invalid_params[ $key ] = $sanitized_value->get_error_message();
+                    $invalid_params[ $key ]  = implode( ' ', $sanitized_value->get_error_messages() );
+                    $invalid_details[ $key ] = rest_convert_error_to_response( $sanitized_value )->get_data();
                 } else {
                     $this->params[ $type ][ $key ] = $sanitized_value;
@@ -842 +845 @@
                 sprintf( __( 'Invalid parameter(s): %s' ), implode( ', ', array_keys( $invalid_params ) ) ),
                 array(
-                    'status' => 400,
-                    'params' => $invalid_params,
+                    'status'  => 400,
+                    'params'  => $invalid_params,
+                    'details' => $invalid_details,
                 )
             );
@@ -895 +899 @@
          * This is done after required checking as required checking is cheaper.
          */
-        $invalid_params = array();
+        $invalid_params  = array();
+        $invalid_details = array();
 
         foreach ( $args as $key => $arg ) {
@@ -902 +907 @@
 
             if ( null !== $param && ! empty( $arg['validate_callback'] ) ) {
+                /** @var bool|\WP_Error $valid_check */
                 $valid_check = call_user_func( $arg['validate_callback'], $param, $this, $key );
 
@@ -909 +915 @@
 
                 if ( is_wp_error( $valid_check ) ) {
-                    $invalid_params[ $key ] = $valid_check->get_error_message();
+                    $invalid_params[ $key ]  = implode( ' ', $valid_check->get_error_messages() );
+                    $invalid_details[ $key ] = rest_convert_error_to_response( $valid_check )->get_data();
                 }
             }
@@ -920 +927 @@
                 sprintf( __( 'Invalid parameter(s): %s' ), implode( ', ', array_keys( $invalid_params ) ) ),
                 array(
-                    'status' => 400,
-                    'params' => $invalid_params,
+                    'status'  => 400,
+                    'params'  => $invalid_params,
+                    'details' => $invalid_details,
                 )
             );