Changeset 38422

Timestamp:

08/28/2016 05:41:25 PM (9 years ago)

Author:

johnbillion

Message:

Formatting: Add a parameter to wp_send_json_error(), wp_send_json_success(), and wp_send_json() for specifying the HTTP response code.

Defaults to 200 in all cases, but can be used, for example, to return a 403 when using wp_send_json_error().

Fixes #35666
Props stephenharris

File:

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

trunk/src/wp-includes/functions.php

@@ -3091 +3091 @@
  *
  * @since 3.5.0
- *
- * @param mixed $response Variable (usually an array or object) to encode as JSON,
- *                        then print and die.
- */
-function wp_send_json( $response ) {
+ * @since 4.7.0 The `$status_code` parameter was added.
+ *
+ * @param mixed $response    Variable (usually an array or object) to encode as JSON,
+ *                           then print and die.
+ * @param int   $status_code The HTTP status code to output.
+ */
+function wp_send_json( $response, $status_code = 200 ) {
     @header( 'Content-Type: application/json; charset=' . get_option( 'blog_charset' ) );
+    status_header( $status_code );
     echo wp_json_encode( $response );
     if ( wp_doing_ajax() )
@@ -3108 +3111 @@
  *
  * @since 3.5.0
- *
- * @param mixed $data Data to encode as JSON, then print and die.
- */
-function wp_send_json_success( $data = null ) {
+ * @since 4.7.0 The `$status_code` parameter was added.
+ *
+ * @param mixed $data        Data to encode as JSON, then print and die.
+ * @param int   $status_code The HTTP status code to output.
+ */
+function wp_send_json_success( $data = null, $status_code = 200 ) {
     $response = array( 'success' => true );
 
@@ -3117 +3122 @@
         $response['data'] = $data;
 
-    wp_send_json( $response );
+    wp_send_json( $response, $status_code );
 }
 
@@ -3130 +3135 @@
  * @since 3.5.0
  * @since 4.1.0 The `$data` parameter is now processed if a WP_Error object is passed in.
- *
- * @param mixed $data Data to encode as JSON, then print and die.
- */
-function wp_send_json_error( $data = null ) {
+ * @since 4.7.0 The `$status_code` parameter was added.
+ *
+ * @param mixed $data        Data to encode as JSON, then print and die.
+ * @param int   $status_code The HTTP status code to output.
+ */
+function wp_send_json_error( $data = null, $status_code = 200 ) {
     $response = array( 'success' => false );
 
@@ -3151 +3158 @@
     }
 
-    wp_send_json( $response );
+    wp_send_json( $response, $status_code );
 }