network_admin_url() WordPress Function

The network_admin_url() function is used to retrieve the URL of the network administration panel for the current network. This function is only available for sites running on a WordPress network (multisite).

network_admin_url( string $path = '', string $scheme = 'admin' ) #

Retrieves the URL to the admin area for the network.


Parameters

$path

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

Default value: ''

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


Top ↑

Return

(string) Admin URL link with optional path appended.


Top ↑

More Information

  • The network_admin_url template tag retrieves the URL to the Network Admin area for the current site with the appropriate protocol, “https” if is_ssl() and “http” otherwise. If $scheme is “http” or “https”, is_ssl() is overridden.
  • If the site is not setup as multisite, admin_url() will be used instead.

Top ↑

Source

File: wp-includes/link-template.php

function network_admin_url( $path = '', $scheme = 'admin' ) {
	if ( ! is_multisite() ) {
		return admin_url( $path, $scheme );
	}

	$url = network_site_url( 'wp-admin/network/', $scheme );

	if ( $path && is_string( $path ) ) {
		$url .= ltrim( $path, '/' );
	}

	/**
	 * Filters the network admin URL.
	 *
	 * @since 3.0.0
	 * @since 5.8.0 The `$scheme` parameter was added.
	 *
	 * @param string      $url    The complete network admin URL including scheme and path.
	 * @param string      $path   Path relative to the network admin 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( 'network_admin_url', $url, $path, $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