user_admin_url( string $path = '', string $scheme = 'admin' ): string
Retrieves the URL to the admin area for the current user.
Parameters
-
$path
string Optional -
Path relative to the admin URL.
Default:
''
-
$scheme
string Optional -
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
string Admin URL link with optional path appended.
Source
File: wp-includes/link-template.php
.
View all references
function user_admin_url( $path = '', $scheme = 'admin' ) {
$url = network_site_url( 'wp-admin/user/', $scheme );
if ( $path && is_string( $path ) ) {
$url .= ltrim( $path, '/' );
}
/**
* Filters the user admin URL for the current user.
*
* @since 3.1.0
* @since 5.8.0 The `$scheme` parameter was added.
*
* @param string $url The complete URL including scheme and path.
* @param string $path Path relative to the URL. Blank string if
* no path is specified.
* @param string|null $scheme The scheme to use. Accepts 'http', 'https',
* 'admin', or null. Default is 'admin', which obeys force_ssl_admin() and is_ssl().
*/
return apply_filters( 'user_admin_url', $url, $path, $scheme );
}
Hooks
-
apply_filters( 'user_admin_url',
string $url ,string $path ,string|null $scheme ) -
Filters the user admin URL for the current user.
Changelog
Version | Description |
---|---|
3.0.0 | Introduced. |