wppaste
WordPress

wp_redirect_admin_locations()

Since
3.4.0
Source
wp-includes/canonical.php:1038
Redirects a variety of shorthand URLs to the admin.

Description

If a user visits example.com/admin, they'll be redirected to /wp-admin.
Visiting /login redirects to /wp-login.php, and so on.

Compatibility

WordPress
since 3.4.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.

Performance profile

How much work a call to wp_redirect_admin_locations() 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
5–87

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

  • hookthird-party callbacksapply_filters()one call below wp_redirect_admin_locations()

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 · 6 distinct outcomes

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

WhenInstructionsCalls it makes
!is_404()5is_404()
is_404() && !->using_permalinks()8is_404(), ->using_permalinks()
is_404() && ->using_permalinks() && !$admins && !$logins73is_404(), ->using_permalinks(), home_url(), home_url(), home_url(), site_url(), site_url(), untrailingslashit(), home_url(), home_url(), home_url(), site_url(), untrailingslashit()
is_404() && ->using_permalinks() && !$admins && $logins80is_404(), ->using_permalinks(), home_url(), home_url(), home_url(), site_url(), site_url(), untrailingslashit(), home_url(), home_url(), home_url(), site_url(), untrailingslashit(), wp_login_url(), wp_redirect(), exit()
is_404() && ->using_permalinks() && $admins && !$logins80is_404(), ->using_permalinks(), home_url(), home_url(), home_url(), site_url(), site_url(), untrailingslashit(), admin_url(), wp_redirect(), exit(), home_url(), home_url(), home_url(), site_url(), untrailingslashit()
is_404() && ->using_permalinks() && $admins && $logins87is_404(), ->using_permalinks(), home_url(), home_url(), home_url(), site_url(), site_url(), untrailingslashit(), admin_url(), wp_redirect(), exit(), home_url(), home_url(), home_url(), site_url(), untrailingslashit(), wp_login_url(), wp_redirect(), exit()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev885–874
8.5885–874
8.4885–8744 fewer instructions than PHP 8.3
8.3925–844
8.2925–844
8.1925–844
7.4925–844

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.

Uses · 7

  • is_404()Determines whether the query has resulted in a 404 (returns no results).
  • home_url()Retrieves the URL for the current site where the front end is accessible.
  • site_url()Retrieves the URL for the current site where WordPress application files (e.g. wp-blog-header.php or the wp-admin/ folder) are accessible.
  • untrailingslashit()Removes trailing forward slashes and backslashes if they exist.
  • wp_redirect()Redirects to another page.
  • admin_url()Retrieves the URL to the admin area for the current site.
  • wp_login_url()Retrieves the login URL.

Source code

function wp_redirect_admin_locations() {	global $wp_rewrite; 	if ( ! ( is_404() && $wp_rewrite->using_permalinks() ) ) {		return;	} 	$admins = array(		home_url( 'wp-admin', 'relative' ),		home_url( 'dashboard', 'relative' ),		home_url( 'admin', 'relative' ),		site_url( 'dashboard', 'relative' ),		site_url( 'admin', 'relative' ),	); 	if ( in_array( untrailingslashit( $_SERVER['REQUEST_URI'] ), $admins, true ) ) {		wp_redirect( admin_url() );		exit;	} 	$logins = array(		home_url( 'wp-login.php', 'relative' ),		home_url( 'login.php', 'relative' ),		home_url( 'login', 'relative' ),		site_url( 'login', 'relative' ),	); 	if ( in_array( untrailingslashit( $_SERVER['REQUEST_URI'] ), $logins, true ) ) {		wp_redirect( wp_login_url() );		exit;	}}

Changelog

Introduced in 3.4.0. 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/canonical.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.