get_admin_url() WordPress Function

The get_admin_url() function is used to get the URL to the admin area for the current site. This function is useful for creating links to the admin area from outside the admin area.

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

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


Parameters

$blog_id

(int|null)(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

(string) Admin URL link with optional path appended.


Top ↑

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
	 * @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 );
}


Top ↑

Changelog

Changelog
VersionDescription
3.0.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More
Show More