network_site_url() WordPress Function
The network_site_url() function in WordPress allows you to get the URL of the main site in a WordPress network. This is useful if you need to hardcode a URL to the main site in a plugin or theme.
network_site_url( string $path = '', string|null $scheme = null ) #
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.
See also
Parameters
- $path
(string)(Optional) Path relative to the site URL.
Default value: ''
- $scheme
(string|null)(Optional) Scheme to give the site URL context. Accepts 'http', 'https', or 'relative'.
Default value: null
Return
(string) Site URL link with optional path appended.
Source
File: wp-includes/link-template.php
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 );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 3.0.0 | Introduced. |