wp_redirect( string $location, int $status = 302 )
Redirects to another page.
Description
Note: wp_redirect() does not exit automatically, and should almost always be followed by a call to exit;:
wp_redirect( $url );
exit;Exiting can also be selectively manipulated by using wp_redirect() as a conditional
in conjunction with the ‘wp_redirect’ and ‘wp_redirect_location’ hooks:
if ( wp_redirect( $url ) ) {
exit;
}Parameters
- $location
-
(string) (Required) The path to redirect to.
- $status
-
(int) (Optional) Status code to use.
Default value: 302
Return
(bool) False if $location is not provided, true otherwise.
Source
File: wp-includes/pluggable.php
function wp_redirect($location, $status = 302) {
global $is_IIS;
/**
* Filters the redirect location.
*
* @since WP-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 );
/**
* Filters the redirect status code.
*
* @since WP-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;
$location = wp_sanitize_redirect($location);
if ( !$is_IIS && PHP_SAPI != 'cgi-fcgi' )
status_header($status); // This causes problems on IIS and some FastCGI setups
header("Location: $location", true, $status);
return true;
}
Changelog
| Version | Description |
|---|---|
| WP-1.5.1 | Introduced. |