get_admin_url( int|null $blog_id = null, string $path = '', string $scheme = 'admin' ): string
Retrieves the URL to the admin area for a given site.
Parameters
-
$blog_id
int|null Optional -
Site ID. Default null (current site).
Default:
null
-
$path
string Optional -
Path relative to the admin URL.
Default:
''
-
$scheme
string Optional -
The scheme to use. Accepts
'http'
or'https'
, to force those schemes. Default'admin'
, which obeys force_ssl_admin() and is_ssl() .Default:
'admin'
Return
string Admin URL link with optional path appended.
Source
File: wp-includes/link-template.php
.
View all references
function get_admin_url( $blog_id = null, $path = '', $scheme = 'admin' ) {
$url = get_site_url( $blog_id, 'wp-admin/', $scheme );
if ( $path && is_string( $path ) ) {
$url .= ltrim( $path, '/' );
}
/**
* Filters the admin area URL.
*
* @since 2.8.0
* @since 5.8.0 The `$scheme` parameter was added.
*
* @param string $url The complete admin area URL including scheme and path.
* @param string $path Path relative to the admin area URL. Blank string if no path is specified.
* @param int|null $blog_id Site ID, or null for the current site.
* @param string|null $scheme The scheme to use. Accepts 'http', 'https',
* 'admin', or null. Default 'admin', which obeys force_ssl_admin() and is_ssl().
*/
return apply_filters( 'admin_url', $url, $path, $blog_id, $scheme );
}
Hooks
-
apply_filters( 'admin_url',
string $url ,string $path ,int|null $blog_id ,string|null $scheme ) -
Filters the admin area URL.
Changelog
Version | Description |
---|---|
3.0.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
This will return the url to wp-admin with a slash:
Example:
http://www.mysite.com/wp-admin/
To get the URL for the network admin, use
network_admin_url()
.