Retrieves the URL for a given site where WordPress application files (e.g. wp-blog-header.php or the wp-admin/ folder) are accessible.
Description
Returns the ‘site_url’ option with the appropriate protocol, ‘https’ if is_ssl() and ‘http’ otherwise. If $scheme
is ‘http’ or ‘https’, is_ssl()
is overridden.
Parameters
$blog_id
int|nulloptional- Site ID. Default null (current site).
Default:
null
$path
stringoptional- Path relative to the site URL.
Default:
''
$scheme
string|nulloptional- Scheme to give the site URL context. Accepts
'http'
,'https'
,'login'
,'login_post'
,'admin'
, or'relative'
.Default:
null
Source
function get_site_url( $blog_id = null, $path = '', $scheme = null ) {
if ( empty( $blog_id ) || ! is_multisite() ) {
$url = get_option( 'siteurl' );
} else {
switch_to_blog( $blog_id );
$url = get_option( 'siteurl' );
restore_current_blog();
}
$url = set_url_scheme( $url, $scheme );
if ( $path && is_string( $path ) ) {
$url .= '/' . ltrim( $path, '/' );
}
/**
* Filters the site URL.
*
* @since 2.7.0
*
* @param string $url The complete site URL including scheme and path.
* @param string $path Path relative to the site URL. Blank string if no path is specified.
* @param string|null $scheme Scheme to give the site URL context. Accepts 'http', 'https', 'login',
* 'login_post', 'admin', 'relative' or null.
* @param int|null $blog_id Site ID, or null for the current site.
*/
return apply_filters( 'site_url', $url, $path, $scheme, $blog_id );
}
Hooks
Changelog
Version | Description |
---|---|
3.0.0 | Introduced. |
Results in the full site URL being displayed:
http://www.example.com
The value is without a trailing slash, e.g.,
https://www.example.com
, nothttps://www.example.com/
.To get just the hostname/domain component of the Site URL (without paths, schema, etc.) you could use the following:
preg_replace('#^https?://#', '', get_site_url())
is a better alternative?if WP installed into subfolder, returns:
https://www.example.com/sub/folder
When you need to pass the scheme as well.