get_admin_url( int $blog_id = null, string $path = '', string $scheme = 'admin' )

Retrieves the URL to the admin area for a given site.


Description Description


Parameters Parameters

$blog_id

(int) (Optional) Site ID. Default null (current site).

Default value: null

$path

(string) (Optional) Path relative to the admin URL.

Default value: ''

$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 value: 'admin'


Top ↑

Return Return

(string) Admin URL link with optional path appended.


Top ↑

Source Source

File: wp-includes/link-template.php

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
	 *
	 * @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.
	 */
	return apply_filters( 'admin_url', $url, $path, $blog_id );
}

Top ↑

Changelog Changelog

Changelog
Version Description
3.0.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.