sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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

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

Fixes #36271.

Props rmccue, TimothyBlynJacobs.



git-svn-id: https://develop.svn.wordpress.org/trunk@48361 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Jake Spurlock 2020-07-07 04:59:51 +00:00
parent bbe94ef0fd
commit 7166def7ec
2 changed files with 33 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/wp-includes/functions.php
View File

@ -4038,6 +4038,10 @@ function _wp_json_prepare_data( $data ) {
* @param int $status_code The HTTP status code to output. * @param int $status_code The HTTP status code to output.
*/ */
function wp_send_json( $response, $status_code = null ) { 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() ) { if ( ! headers_sent() ) {
header( 'Content-Type: application/json; charset=' . get_option( 'blog_charset' ) ); header( 'Content-Type: application/json; charset=' . get_option( 'blog_charset' ) );
if ( null !== $status_code ) { if ( null !== $status_code ) {

29
src/wp-includes/rest-api.php
View File

@ -184,6 +184,8 @@ function rest_api_default_filters() {
add_filter( 'deprecated_function_trigger_error', '__return_false' ); add_filter( 'deprecated_function_trigger_error', '__return_false' );
add_action( 'deprecated_argument_run', 'rest_handle_deprecated_argument', 10, 3 ); add_action( 'deprecated_argument_run', 'rest_handle_deprecated_argument', 10, 3 );
add_filter( 'deprecated_argument_trigger_error', '__return_false' ); 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' );
} }
// Default serving. // Default serving.
@ -597,6 +599,33 @@ function rest_handle_deprecated_argument( $function, $message, $version ) {
header( sprintf( 'X-WP-DeprecatedParam: %s', $string ) ); 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 ) );
}
/** /**
* Sends Cross-Origin Resource Sharing headers with API requests. * Sends Cross-Origin Resource Sharing headers with API requests.
* *