wp_redirect() WP 1.0

Redirects to another page.

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 {@see 'wp_redirect_location'} hooks:

if ( wp_redirect( $url ) ) {
	exit;
}

Hooks in function

Return

true/false. False if $location is not provided, true otherwise.

Usage

wp_redirect( $location, $status );

$location(string) (required)

The path to redirect to.

$status(int)

Status code to use.
Default: 302

Code of wp redirect: wp-includes/pluggable.php ^{VER 5.0.3}

<?php
function wp_redirect($location, $status = 302) {
	global $is_IIS;

	/**
	 * Filters 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 );

	/**
	 * Filters 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;

	$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;
}

Related Functions

From tag: Supporting (helper utility auxiliary)

More from category: Uncategorized