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

Timestamp:

11/20/2017 08:23:50 PM (7 years ago)

Author:

johnbillion

Message:

General: Pass on the return value from wp_redirect() for wp_safe_redirect().

This brings the behaviour of the two functions in line with each other.

Props Drivingralle

Fixes 42108

File:

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

trunk/src/wp-includes/pluggable.php

@@ -1286 +1286 @@
  *     exit;
  *
+ * Exiting can also be selectively manipulated by using wp_safe_redirect() as a conditional
+ * in conjunction with the {@see 'wp_redirect'} and {@see 'wp_redirect_location'} filters:
+ *
+ *     if ( wp_safe_redirect( $url ) ) {
+ *         exit;
+ *     }
+ *
  * @since 2.3.0
+ * @since 5.0.0 The return value from wp_redirect() is now passed on.
  *
  * @param string $location The path or URL to redirect to.
  * @param int    $status   Optional. HTTP response status code to use. Default '302' (Moved Temporarily).
+ * @return bool  $redirect False if the redirect was cancelled, true otherwise.
  */
 function wp_safe_redirect($location, $status = 302) {
@@ -1306 +1315 @@
     $location = wp_validate_redirect( $location, apply_filters( 'wp_safe_redirect_fallback', admin_url(), $status ) );
 
-    wp_redirect($location, $status);
+    return wp_redirect( $location, $status );
 }
 endif;