wp_safe_redirect( string $location, int $status = 302, string|false $x_redirect_by = 'WordPress' ): bool
- Since
- 2.3.0, 5.1.0
- Source
wp-includes/pluggable.php:1624
Description
Checks whether the $location is using an allowed host, if it has an absolute path. A plugin can therefore set or remove allowed host(s) to or from the list.
If the host is not allowed, then the redirect defaults to wp-admin on the siteurl instead. This prevents malicious redirects which redirect to another host, but only used in a few places.
Note: wp_safe_redirect() does not exit automatically, and should almost always be followed by a call to exit;:
wp_safe_redirect( $url );
exit;Exiting can also be selectively manipulated by using wp_safe_redirect() as a conditional in conjunction with the 'wp_redirect' and 'wp_redirect_status' filters:
if ( wp_safe_redirect( $url ) ) {
exit;
}Compatibility
- WordPress
- since 5.1.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
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_safe_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
- Scaling
- Constant
- Instructions
- 26
- Plugin surface
- 1 hook
- Called by
- 5
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5. The body compiles to 26.
Third-party callbacks on 'wp_safe_redirect_fallback' run inside this call, and their cost is not bounded by anything here.
5 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()called directly
Further down the call graph this can also reach option, cache, serialize, query 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 · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_safe_redirect() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 26 | wp_sanitize_redirect(), admin_url(), apply_filters(), wp_validate_redirect(), wp_redirect() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 26 instructions, 26 executed per call, 0 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Hooks and filters fired · 1
One hook fires while wp_safe_redirect() runs, in this order:
- apply_filters( wp_safe_redirect_fallback )filterline 1637 (+13 into the body)
Filters the redirect fallback URL for when the provided redirect is not safe (local).
Uses · 5
- wp_sanitize_redirect()Sanitizes a URL for use in a redirect.
- apply_filters()Calls the callback functions that have been added to a filter hook.
- admin_url()Retrieves the URL to the admin area for the current site.
- wp_validate_redirect()Validates a URL for use in a redirect.
- wp_redirect()Redirects to another page.
Used by · 5
- Custom_Background::take_action()Executes custom background modification.
- WP_Recovery_Mode::handle_exit_recovery_mode()Handles a request to exit Recovery Mode.
- WP_Recovery_Mode::redirect_protected()Redirects the current request to allow recovering multiple errors in one go.
- WP_Sitemaps::redirect_sitemapxml()Redirects a URL to the wp-sitemap.xml
- set_screen_options()Saves option for number of rows when listing posts, pages, comments, etc.
Source code
function wp_safe_redirect( $location, $status = 302, $x_redirect_by = 'WordPress' ) { // Need to look at the URL the way it will end up in wp_redirect(). $location = wp_sanitize_redirect( $location ); /** * Filters the redirect fallback URL for when the provided redirect is not safe (local). * * @since 4.3.0 * * @param string $fallback_url The fallback URL to use by default. * @param int $status The HTTP response status code to use. */ $fallback_url = apply_filters( 'wp_safe_redirect_fallback', admin_url(), $status ); $location = wp_validate_redirect( $location, $fallback_url ); return wp_redirect( $location, $status, $x_redirect_by ); }Changelog
Introduced in 2.3.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
$x_redirect_by parameter was added.from the docblockAbout 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.