Changeset 4543 for trunk/includes/common/functions.php

Timestamp:

12/05/2012 09:02:01 PM (13 years ago)

Author:

johnjamesjacoby

Message:

Subscriptions/Favorites:

• Improvements to AJAX handling.
• Introduces bbp_ajax_response() function in common/functions.php, to handle JSON output.
• Adds AJAX failure responses.
• Props MZAWeb.
• Fixes #1905.

File:

• trunk/includes/common/functions.php (modified) (1 diff)

trunk/includes/common/functions.php

@@ -1688 +1688 @@
     $wp_query->set_404();
 }
+
+/**
+ * Helper method to return JSON response for the ajax calls
+ *
+ * @since bbPress (r4542)
+ *
+ * @param bool $success
+ * @param string $content
+ * @param array $extras
+ */
+function bbp_ajax_response( $success = false, $content = '', $status = -1, $extras = array() ) {
+
+    // Set status to 200 if setting response as successful
+    if ( ( true === $success ) && ( -1 === $status ) )
+        $status = 200;
+
+    // Setup the response array
+    $response = array(
+        'success' => $success,
+        'status'  => $status,
+        'content' => $content
+    );
+
+    // Merge extra response parameters in
+    if ( !empty( $extras ) && is_array( $extras ) ) {
+        $response = array_merge( $response, $extras );
+    }
+
+    // Send back the JSON
+    header( 'Content-type: application/json' );
+    echo json_encode( $response );
+    die();
+}