Changeset 25230 for trunk/src/wp-includes/pluggable.php

Timestamp:

09/04/2013 08:30:37 AM (12 years ago)

Author:

SergeyBiryukov

Message:

Add phpdoc for 'wp_redirect' and 'wp_redirect_status' filters. props DrewAPicture. fixes #25215.

File:

• trunk/src/wp-includes/pluggable.php (modified) (2 diffs)

trunk/src/wp-includes/pluggable.php

@@ -858 +858 @@
  * @uses apply_filters() Calls 'wp_redirect' hook on $location and $status.
  *
- * @param string $location The path to redirect to
- * @param int $status Status code to use
+ * @param string $location The path to redirect to.
+ * @param int $status Status code to use.
  * @return bool False if $location is not provided, true otherwise.
  */
@@ -865 +865 @@
     global $is_IIS;
 
-    $location = apply_filters('wp_redirect', $location, $status);
-    $status = apply_filters('wp_redirect_status', $status, $location);
-
-    if ( !$location ) // allows the wp_redirect filter to cancel a redirect
+    /**
+     * Filter the redirect location
+     *
+     * @since 2.1.0
+     *
+     * @param string $location The path to redirect to.
+     * @param int    $status   Status code to use.
+     */
+    $location = apply_filters( 'wp_redirect', $location, $status );
+
+    /**
+     * Filter the redirect status code
+     *
+     * @since 2.3.0
+     *
+     * @param int    $status   Status code to use.
+     * @param string $location The path to redirect to.
+     */
+    $status = apply_filters( 'wp_redirect_status', $status, $location );
+
+    if ( ! $location )
         return false;