wp_redirect( string $location, int $status = 302, string|false $x_redirect_by = 'WordPress' ): bool

Description

wp_redirect( $url );
exit;

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

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$locationstring

The path or URL to redirect to.

$statusintoptional

HTTP response status code to use. Default '302' (Moved Temporarily).Default: 302

$x_redirect_bystring|falseoptional

The application doing the redirect or false to omit. Default 'WordPress'.Default: 'WordPress'

Return value

bool

False if the redirect was canceled, true otherwise.

Performance profile

How much work a call to wp_redirect() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

18–55

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 56.

Plugin surface

3 hooks

Third-party callbacks on 'wp_redirect', 'wp_redirect_status', 'x_redirect_by' run inside this call, and their cost is not bounded by anything here.

Called by

21

21 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 9 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_redirect() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 3

3 hooks fire while wp_redirect() runs, in this order:

1. 1
   apply_filters( wp_redirect )filterline 1492 (+11 into the body)

   Filters the redirect location.

2. 2
   apply_filters( wp_redirect_status )filterline 1502 (+21 into the body)

   Filters the redirect HTTP response status code to use.

3. 3
   apply_filters( x_redirect_by )filterline 1529 (+48 into the body)

   Filters the X-Redirect-By header.

Uses · 5

• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_die()Kills WordPress execution and displays HTML page with an error message.
• __()Retrieves the translation of $text.
• wp_sanitize_redirect()Sanitizes a URL for use in a redirect.
• status_header()Sets HTTP status header.

Used by · 21

• WP_Customize_Manager::after_setup_theme()Callback to validate a theme once it is loaded
• WP_List_Table::set_pagination_args()Sets all the necessary pagination arguments.
• WP_Recovery_Mode_Link_Service::handle_begin_link()Enters recovery mode when the user hits wp-login.php with a valid recovery mode link.
• activate_plugin()Attempts activation of plugin in a "sandbox" and redirects on success.
• auth_redirect()Checks if a user is logged in, if not it redirects them to the login page.
• do_dismiss_core_update()Dismiss a core update.
• do_favicon()Displays the favicon.ico file content.
• do_undismiss_core_update()Undismiss a core update.
• maybe_redirect_404()Corrects 404 redirects when NOBLOGREDIRECT is defined.
• redirect_canonical()Redirects incoming links to the proper URL based on the site url.
• redirect_post()Redirects to previous page.
• resume_plugin()Tries to resume a single plugin.

Source code

View on Trac ↗View on GitHub ↗

1481	function wp_redirect( $location, $status = 302, $x_redirect_by = 'WordPress' ) {1482		global $is_IIS;1483 1484		/**1485		 * Filters the redirect location.1486		 *1487		 * @since 2.1.01488		 *1489		 * @param string $location The path or URL to redirect to.1490		 * @param int    $status   The HTTP response status code to use.1491		 */1492		$location = apply_filters( 'wp_redirect', $location, $status );1493 1494		/**1495		 * Filters the redirect HTTP response status code to use.1496		 *1497		 * @since 2.3.01498		 *1499		 * @param int    $status   The HTTP response status code to use.1500		 * @param string $location The path or URL to redirect to.1501		 */1502		$status = apply_filters( 'wp_redirect_status', $status, $location );1503 1504		if ( ! $location ) {1505			return false;1506		}1507 1508		if ( $status < 300 || 399 < $status ) {1509			wp_die( __( 'HTTP redirect status code must be a redirection code, 3xx.' ) );1510		}1511 1512		$location = wp_sanitize_redirect( $location );1513 1514		if ( ! $is_IIS && 'cgi-fcgi' !== PHP_SAPI ) {1515			status_header( $status ); // This causes problems on IIS and some FastCGI setups.1516		}1517 1518		/**1519		 * Filters the X-Redirect-By header.1520		 *1521		 * Allows applications to identify themselves when they're doing a redirect.1522		 *1523		 * @since 5.1.01524		 *1525		 * @param string|false $x_redirect_by The application doing the redirect or false to omit the header.1526		 * @param int          $status        Status code to use.1527		 * @param string       $location      The path to redirect to.1528		 */1529		$x_redirect_by = apply_filters( 'x_redirect_by', $x_redirect_by, $status, $location );1530		if ( is_string( $x_redirect_by ) ) {1531			header( "X-Redirect-By: $x_redirect_by" );1532		}1533 1534		header( "Location: $location", true, $status );1535 1536		return true;1537	}

Changelog

Introduced in 1.5.1. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/pluggable.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.