get_dashboard_url( int $user_id = 0, string $path = '', string $scheme = 'admin' ): string

Description

Compatibility

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

Parameters

$user_idintoptional

User ID. Defaults to current user.Default: 0

$pathstringoptional

Optional path relative to the dashboard. Use only paths known to both site and user admins. 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

Dashboard URL link with optional path appended.

Performance profile

How much work a call to get_dashboard_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

Moderate

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Constant

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

Instructions

31–62

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

Plugin surface

1 hook

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

Called by

5

5 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
• optionoption read or writeget_option()one call below get_dashboard_url()

Further down the call graph this can also reach 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 · 30 distinct outcomes

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

Hooks and filters fired · 1

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

1. 1
   apply_filters( user_dashboard_url )filterline 4010 (+35 into the body)

   Filters the dashboard URL for a user.

Uses · 10

• get_current_user_id()Gets the current user's ID.
• get_blogs_of_user()Gets the sites a user belongs to.
• is_multisite()Determines whether Multisite is enabled.
• user_can()Returns whether a particular user has the specified capability.
• user_admin_url()Retrieves the URL to the admin area for the current user.
• admin_url()Retrieves the URL to the admin area for the current site.
• get_current_blog_id()Retrieves the current site ID.
• get_active_blog_for_user()Gets one of a user's active blogs.
• get_admin_url()Retrieves the URL to the admin area for a given site.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 5

• get_edit_profile_url()Retrieves the URL to the user's profile editor.
• wp_admin_bar_dashboard_view_site_menu()Add the "Dashboard"/"Visit Site" menu.
• wp_admin_bar_my_account_item()Adds the "My Account" item.
• wp_admin_bar_my_account_menu()Adds the "My Account" submenu items.
• wp_admin_bar_wp_menu()Adds the WordPress logo menu.

Source code

View on Trac ↗View on GitHub ↗

3975function get_dashboard_url( $user_id = 0, $path = '', $scheme = 'admin' ) {3976	$user_id = $user_id ? (int) $user_id : get_current_user_id();3977 3978	$blogs = get_blogs_of_user( $user_id );3979 3980	if ( is_multisite() && ! user_can( $user_id, 'manage_network' ) && empty( $blogs ) ) {3981		$url = user_admin_url( $path, $scheme );3982	} elseif ( ! is_multisite() ) {3983		$url = admin_url( $path, $scheme );3984	} else {3985		$current_blog = get_current_blog_id();3986 3987		if ( $current_blog && ( user_can( $user_id, 'manage_network' ) || in_array( $current_blog, array_keys( $blogs ), true ) ) ) {3988			$url = admin_url( $path, $scheme );3989		} else {3990			$active = get_active_blog_for_user( $user_id );3991			if ( $active ) {3992				$url = get_admin_url( $active->blog_id, $path, $scheme );3993			} else {3994				$url = user_admin_url( $path, $scheme );3995			}3996		}3997	}3998 3999	/**4000	 * Filters the dashboard URL for a user.4001	 *4002	 * @since 3.1.04003	 *4004	 * @param string $url     The complete URL including scheme and path.4005	 * @param int    $user_id The user ID.4006	 * @param string $path    Path relative to the URL. Blank string if no path is specified.4007	 * @param string $scheme  Scheme to give the URL context. Accepts 'http', 'https', 'login',4008	 *                        'login_post', 'admin', 'relative' or null.4009	 */4010	return apply_filters( 'user_dashboard_url', $url, $user_id, $path, $scheme );4011}

Changelog

Introduced in 3.1.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.8.8 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.