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

Timestamp:

02/02/2021 05:26:06 PM (3 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.php (modified) (1 diff)

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

@@ -3183 +3183 @@
     return $endpoint_args;
 }
+
+
+/**
+ * Converts an error to a response object.
+ *
+ * This iterates over all error codes and messages to change it into a flat
+ * array. This enables simpler client behaviour, as it is represented as a
+ * list in JSON rather than an object/map.
+ *
+ * @since 5.7.0
+ *
+ * @param WP_Error $error WP_Error instance.
+ *
+ * @return WP_REST_Response List of associative arrays with code and message keys.
+ */
+function rest_convert_error_to_response( $error ) {
+    $status = array_reduce(
+        $error->get_all_error_data(),
+        function ( $status, $error_data ) {
+            return is_array( $error_data ) && isset( $error_data['status'] ) ? $error_data['status'] : $status;
+        },
+        500
+    );
+
+    $errors = array();
+
+    foreach ( (array) $error->errors as $code => $messages ) {
+        $all_data  = $error->get_all_error_data( $code );
+        $last_data = array_pop( $all_data );
+
+        foreach ( (array) $messages as $message ) {
+            $formatted = array(
+                'code'    => $code,
+                'message' => $message,
+                'data'    => $last_data,
+            );
+
+            if ( $all_data ) {
+                $formatted['additional_data'] = $all_data;
+            }
+
+            $errors[] = $formatted;
+        }
+    }
+
+    $data = $errors[0];
+    if ( count( $errors ) > 1 ) {
+        // Remove the primary error.
+        array_shift( $errors );
+        $data['additional_errors'] = $errors;
+    }
+
+    return new WP_REST_Response( $data, $status );
+}