user_admin_url( string $path = '', string $scheme = 'admin' ): string

Compatibility

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

Parameters

$pathstringoptional

Path relative to the admin URL. Default empty.Default: ''

$schemestringoptional

The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.Default: 'admin'

Return value

string

Admin URL link with optional path appended.

Performance profile

How much work a call to user_admin_url() 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

15–22

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

Plugin surface

1 hook

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

Called by

4

4 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 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 · 2 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while user_admin_url() runs, in this order:

1. 1
   apply_filters( user_admin_url )filterline 3885 (+19 into the body)

   Filters the user admin URL for the current user.

Uses · 2

• network_site_url()Retrieves the site URL for the current network.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 4

• WP_Admin_Bar::initialize()Initializes the admin bar.
• get_dashboard_url()Retrieves the URL to the user's dashboard.
• get_edit_profile_url()Retrieves the URL to the user's profile editor.
• self_admin_url()Retrieves the URL to the admin area for either the current site or the network depending on context.

Source code

View on Trac ↗View on GitHub ↗

3866function user_admin_url( $path = '', $scheme = 'admin' ) {3867	$url = network_site_url( 'wp-admin/user/', $scheme );3868 3869	if ( $path && is_string( $path ) ) {3870		$url .= ltrim( $path, '/' );3871	}3872 3873	/**3874	 * Filters the user admin URL for the current user.3875	 *3876	 * @since 3.1.03877	 * @since 5.8.0 The `$scheme` parameter was added.3878	 *3879	 * @param string      $url    The complete URL including scheme and path.3880	 * @param string      $path   Path relative to the URL. Blank string if3881	 *                            no path is specified.3882	 * @param string|null $scheme The scheme to use. Accepts 'http', 'https',3883	 *                            'admin', or null. Default is 'admin', which obeys force_ssl_admin() and is_ssl().3884	 */3885	return apply_filters( 'user_admin_url', $url, $path, $scheme );3886}

Changelog

Introduced in 3.0.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 7.0.4 tag, from src/wp-includes/link-template.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.