network_site_url() – Function | Developer.WordPress.org

Retrieves the site URL for the current network.

Description

Returns the site URL with the appropriate protocol, ‘https’ if is_ssl() and ‘http’ otherwise. If $scheme is ‘http’ or ‘https’, is_ssl() is overridden.

Parameters

$pathstringoptional: Path relative to the site URL.
Default:''
$schemestring|nulloptional: Scheme to give the site URL context. Accepts 'http', 'https', or 'relative'.
Default:null

Return

string Site URL link with optional path appended.

Source

function network_site_url( $path = '', $scheme = null ) {
	if ( ! is_multisite() ) {
		return site_url( $path, $scheme );
	}

	$current_network = get_network();

	if ( 'relative' === $scheme ) {
		$url = $current_network->path;
	} else {
		$url = set_url_scheme( 'http://' . $current_network->domain . $current_network->path, $scheme );
	}

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

	/**
	 * Filters the network site URL.
	 *
	 * @since 3.0.0
	 *
	 * @param string      $url    The complete network site URL including scheme and path.
	 * @param string      $path   Path relative to the network site URL. Blank string if
	 *                            no path is specified.
	 * @param string|null $scheme Scheme to give the URL context. Accepts 'http', 'https',
	 *                            'relative' or null.
	 */
	return apply_filters( 'network_site_url', $url, $path, $scheme );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘network_site_url’, string $url, string $path, string|null $scheme ): Filters the network site URL.

Uses	Description
get_network()`wp-includes/ms-network.php`	Retrieves network data given a network ID or network object.
set_url_scheme()`wp-includes/link-template.php`	Sets the scheme for a URL.
site_url()`wp-includes/link-template.php`	Retrieves the URL for the current site where WordPress application files (e.g. wp-blog-header.php or the wp-admin/ folder) are accessible.
is_multisite()`wp-includes/load.php`	Determines whether Multisite is enabled.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.

Show 2 more Show less

Used by	Description
wp_lostpassword_url()`wp-includes/general-template.php`	Returns the URL that allows the user to reset the lost password.
network_admin_url()`wp-includes/link-template.php`	Retrieves the URL to the admin area for the network.
user_admin_url()`wp-includes/link-template.php`	Retrieves the URL to the admin area for the current user.
redirect_canonical()`wp-includes/canonical.php`	Redirects incoming links to the proper URL based on the site url.

Changelog

Version	Description
3.0.0	Introduced.

User Contributed Notes

Skip to note 4 content

pcarvalho 4 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

if wp is in a subdir /wp/site1/, ‘path’ contains ‘wp/’, so beware.

Log in to add feedback
Skip to note 5 content

Codex 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: -1You must log in to vote on the helpfulness of this note
With https specification
Output: https://www.example.com/contact-us/
```
// Get a secure URL for a specific page within the current site
$url = network_site_url('/contact-us/', 'https');
echo $url;
```
Log in to add feedback
Skip to note 6 content

Codex 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: -2You must log in to vote on the helpfulness of this note
Basic Example
Output: http://www.example.com/wordpress/
```
// Get the current site's URL
$url = network_site_url();
echo $url;
```
Log in to add feedback

network_site_url( string $path = '', string|null $scheme = null ): string

In this article