Changeset 49235

Timestamp:

10/20/2020 03:54:43 PM (4 years ago)

Author:

SergeyBiryukov

Message:

General: Add $options parameter to JSON response functions:

• wp_send_json()
• wp_send_json_success()
• wp_send_json_error()

This allows for customizing the options passed to json_encode().

Props eroraghav, hareesh-pillai, garrett-eclipse.
Fixes #51293.

File:

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

trunk/src/wp-includes/functions.php

@@ -4079 +4079 @@
  * @since 3.5.0
  * @since 4.7.0 The `$status_code` parameter was added.
+ * @since 5.6.0 The `$options` 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 = null ) {
+ * @param int   $status_code Optional. The HTTP status code to output. Default null.
+ * @param int   $options     Optional. Options to be passed to json_encode(). Default 0.
+ */
+function wp_send_json( $response, $status_code = null, $options = 0 ) {
     if ( defined( 'REST_REQUEST' ) && REST_REQUEST ) {
         _doing_it_wrong(
@@ -4105 +4107 @@
     }
 
-    echo wp_json_encode( $response );
+    echo wp_json_encode( $response, $options );
 
     if ( wp_doing_ajax() ) {
@@ -4125 +4127 @@
  * @since 3.5.0
  * @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 = null ) {
+ * @since 5.6.0 The `$options` parameter was added.
+ *
+ * @param mixed $data        Optional. Data to encode as JSON, then print and die. Default null.
+ * @param int   $status_code Optional. The HTTP status code to output. Default null.
+ * @param int   $options     Optional. Options to be passed to json_encode(). Default 0.
+ */
+function wp_send_json_success( $data = null, $status_code = null, $options = 0 ) {
     $response = array( 'success' => true );
 
@@ -4136 +4140 @@
     }
 
-    wp_send_json( $response, $status_code );
+    wp_send_json( $response, $status_code, $options );
 }
 
@@ -4150 +4154 @@
  * @since 4.1.0 The `$data` parameter is now processed if a WP_Error object is passed in.
  * @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 = null ) {
+ * @since 5.6.0 The `$options` parameter was added.
+ *
+ * @param mixed $data        Optional. Data to encode as JSON, then print and die. Default null.
+ * @param int   $status_code Optional. The HTTP status code to output. Default null.
+ * @param int   $options     Optional. Options to be passed to json_encode(). Default 0.
+ */
+function wp_send_json_error( $data = null, $status_code = null, $options = 0 ) {
     $response = array( 'success' => false );
 
@@ -4175 +4181 @@
     }
 
-    wp_send_json( $response, $status_code );
+    wp_send_json( $response, $status_code, $options );
 }