Changeset 5658 for trunk/src/includes/core/functions.php

Timestamp:

03/24/2015 01:32:20 PM (11 years ago)

Author:

johnjamesjacoby

Message:

API: Introduce bbp_redirect()

• Wraps wp_safe_redirect() & exit() calls
• Prevents errors from potentially empty wp_get_referrer() results
• Replace wp_safe_redirect() usages with bbp_redirect()

Fixes #2778.

File:

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

trunk/src/includes/core/functions.php

@@ -584 +584 @@
 }
 
+/** Redirection ***************************************************************/
+
+/**
+ * Perform a safe, local redirect somewhere inside the current site
+ *
+ * On some setups, passing the value of wp_get_referer() may result in an empty
+ * value for $location, which results in an error on redirection. If $location
+ * is empty, we can safely redirect back to the forum root. This might change
+ * in a future version, possibly to the site root.
+ *
+ * @since bbPress (r5658)
+ *
+ * @uses wp_safe_redirect()
+ *
+ * @param string $location The URL to redirect the user to.
+ * @param int    $status   Optional. The numeric code to give in the redirect
+ *                         headers. Default: 302.
+ */
+function bbp_redirect( $location = '', $status = 302 ) {
+
+    // Prevent errors from empty $location
+    if ( empty( $location ) ) {
+        $location = bbp_get_forums_url();
+    }
+
+    // Setup the safe redirect
+    wp_safe_redirect( $location, $status );
+
+    // Exit so the redirect takes place immediately
+    exit();
+}