Retrieves the home URL for the current network.
Description
Returns the home URL with the appropriate protocol, ‘https’ is_ssl() and ‘http’ otherwise. If $scheme
is ‘http’ or ‘https’, is_ssl()
is overridden.
Parameters
$path
stringoptional- Path relative to the home URL.
Default:
''
$scheme
string|nulloptional- Scheme to give the home URL context. Accepts
'http'
,'https'
, or'relative'
.Default:
null
Source
function network_home_url( $path = '', $scheme = null ) {
if ( ! is_multisite() ) {
return home_url( $path, $scheme );
}
$current_network = get_network();
$orig_scheme = $scheme;
if ( ! in_array( $scheme, array( 'http', 'https', 'relative' ), true ) ) {
$scheme = is_ssl() ? 'https' : 'http';
}
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 home URL.
*
* @since 3.0.0
*
* @param string $url The complete network home URL including scheme and path.
* @param string $path Path relative to the network home URL. Blank string
* if no path is specified.
* @param string|null $orig_scheme Scheme to give the URL context. Accepts 'http', 'https',
* 'relative' or null.
*/
return apply_filters( 'network_home_url', $url, $path, $orig_scheme );
}
Hooks
- apply_filters( ‘network_home_url’,
string $url ,string $path ,string|null $orig_scheme ) Filters the network home URL.
Changelog
Version | Description |
---|---|
3.0.0 | Introduced. |
Basic Example
Output: http://www.example.com
Note the lack of a trailing slash.
network_home_url()
on my network, so i wouldn’t depend on it.