Changeset 21679

Timestamp:

08/31/2012 01:56:00 AM (12 years ago)

Author:

nacin

Message:

Introduce wp_send_json() to json-encode a variable, print it, and die, for Ajax requests. Effectively replaces WP_Ajax_Response, which was an XML-based response.

Introduce wp_send_json_success() and wp_send_json_error(), which will allow us to fire appropriate done() or fail() callbacks in JS.

props koopersmith. see #21390.

File:

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

trunk/wp-includes/functions.php

@@ -1800 +1800 @@
     'wma' => 'audio/wma',
     'mka' => 'audio/x-matroska',
-    // Misc application formats 
+    // Misc application formats
     'rtf' => 'application/rtf',
     'js' => 'application/javascript',
@@ -1858 +1858 @@
  * @uses apply_filters() Calls 'upload_mimes' on returned array
  * @uses wp_get_upload_mime_types() to fetch the list of mime types
- * 
+ *
  * @return array Array of mime types keyed by the file extension regex corresponding to those types.
  */
@@ -2141 +2141 @@
         die( (string) $message );
     die();
+}
+
+/**
+ * Send a JSON response back to an Ajax request.
+ *
+ * @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 ) {
+    @header( 'Content-Type: application/json; charset=' . get_option( 'blog_charset' ) );
+    echo json_encode( $json );
+    if ( defined( 'DOING_AJAX' ) && DOING_AJAX )
+        wp_die();
+    else
+        die;
+}
+
+/**
+ * Send a JSON response back to an Ajax request, indicating success.
+ *
+ * @since 3.5.0
+ *
+ * @param mixed $data Data to encode as JSON, then print and die.
+ */
+function wp_send_json_success( $data = null ) {
+    $response = array( 'success' => true );
+
+    if ( isset( $data ) )
+        $response['data'] = $data;
+
+    wp_send_json( $response );
+}
+
+/**
+ * Send a JSON response back to an Ajax request, indicating failure.
+ *
+ * @since 3.5.0
+ *
+ * @param mixed $data Data to encode as JSON, then print and die.
+ */
+function wp_send_json_error( $data = null ) {
+    $response = array( 'success' => false );
+
+    if ( isset( $data ) )
+        $response['data'] = $data;
+
+    wp_send_json( $response );
 }