Changeset 48361

Timestamp:

07/07/2020 04:59:51 AM (4 years ago)

Author:

whyisjake

Message:

REST API: Trigger _doing_it_wrong() if wp_send_json() is used on a REST API request

In addition to triggering the _doing_it_wrong() logging, also adds a X-WP-DoingItWrong header.

Fixes #36271.

Props rmccue, TimothyBlynJacobs.

Location:

trunk/src/wp-includes

Files:

• functions.php (modified) (1 diff)
• rest-api.php (modified) (2 diffs)

trunk/src/wp-includes/functions.php

@@ -4039 +4039 @@
  */
 function wp_send_json( $response, $status_code = null ) {
+    if ( defined( 'REST_REQUEST' ) && REST_REQUEST ) {
+        _doing_it_wrong( __FUNCTION__, __( 'Return a WP_REST_Response or WP_Error object from your callback when using the REST API.' ), '5.5.0' );
+    }
+
     if ( ! headers_sent() ) {
         header( 'Content-Type: application/json; charset=' . get_option( 'blog_charset' ) );

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

@@ -185 +185 @@
         add_action( 'deprecated_argument_run', 'rest_handle_deprecated_argument', 10, 3 );
         add_filter( 'deprecated_argument_trigger_error', '__return_false' );
+        add_action( 'doing_it_wrong_run', 'rest_handle_doing_it_wrong', 10, 3 );
+        add_filter( 'doing_it_wrong_trigger_error', '__return_false' );
     }
 
@@ -596 +598 @@
 
     header( sprintf( 'X-WP-DeprecatedParam: %s', $string ) );
+}
+
+/**
+ * Handles _doing_it_wrong errors.
+ *
+ * @since 5.5.0
+ *
+ * @param string      $function The function that was called.
+ * @param string      $message  A message explaining what has been done incorrectly.
+ * @param string|null $version  The version of WordPress where the message was added.
+ */
+function rest_handle_doing_it_wrong( $function, $message, $version ) {
+    if ( ! WP_DEBUG || headers_sent() ) {
+        return;
+    }
+
+    if ( is_null( $version ) ) {
+        /* translators: Developer debugging message. 1: PHP function name, 2: Explanatory message */
+        $string = __( '%1$s (%2$s)' );
+        $string = sprintf( $string, $function, $message );
+    } else {
+        /* translators: Developer debugging message. 1: PHP function name, 2: Version information message, 3: Explanatory message. */
+        $string = __( '%1$s (since %2$s; %3$s)' );
+        $string = sprintf( $string, $function, $version, $message );
+    }
+
+    header( sprintf( 'X-WP-DoingItWrong: %s', $string ) );
 }