Changeset 57610 for trunk/src/wp-includes/functions.php

Timestamp:

02/13/2024 09:08:43 AM (8 months ago)

Author:

spacedmonkey

Message:

REST API: Provide detailed error data in REST API response.

When the fatal error handler is triggered within a REST API request, it currently utilizes wp_die to display a specially formatted error response. However, crucial information captured by the fatal error handler, such as the exact line where the error occurred, is not included in the response due to potential security concerns, such as leaking file paths.

To address this limitation and aid developers in debugging, this enhancement introduces the inclusion of error data in the response when the WP_DEBUG_DISPLAY constant is set to true. This additional data, appended under the new key error_data, will facilitate more thorough debugging for REST API errors.

Props ecc, spacedmonkey, TimothyBlynJacobs, rcorrales.
Fixes #60014.

File:

• trunk/src/wp-includes/functions.php (modified) (3 diffs)

trunk/src/wp-includes/functions.php

@@ -4052 +4052 @@
     );
 
+    if ( isset( $parsed_args['error_data'] ) ) {
+        $data['data']['error'] = $parsed_args['error_data'];
+    }
+
     if ( ! headers_sent() ) {
         header( "Content-Type: application/json; charset={$parsed_args['charset']}" );
@@ -4089 +4093 @@
         'additional_errors' => $parsed_args['additional_errors'],
     );
+
+    if ( isset( $parsed_args['error_data'] ) ) {
+        $data['data']['error'] = $parsed_args['error_data'];
+    }
 
     if ( ! headers_sent() ) {
@@ -4266 +4274 @@
             if ( empty( $title ) && is_array( $errors[0]['data'] ) && ! empty( $errors[0]['data']['title'] ) ) {
                 $title = $errors[0]['data']['title'];
+            }
+            if ( WP_DEBUG_DISPLAY && is_array( $errors[0]['data'] ) && ! empty( $errors[0]['data']['error'] ) ) {
+                $args['error_data'] = $errors[0]['data']['error'];
             }