get_site_url() – Function | Developer.WordPress.org

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_idint|nulloptional: Site ID. Default null (current site).
Default:null
$pathstringoptional: Path relative to the site URL.
Default:''
$schemestring|nulloptional: Scheme to give the site URL context. Accepts 'http', 'https', 'login', 'login_post', 'admin', or 'relative'.
Default:null

Return

string Site URL link with optional path appended.

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 );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘site_url’, string $url, string $path, string|null $scheme, int|null $blog_id ): Filters the site URL.

Uses	Description
set_url_scheme()`wp-includes/link-template.php`	Sets the scheme for a URL.
switch_to_blog()`wp-includes/ms-blogs.php`	Switches the current blog.
restore_current_blog()`wp-includes/ms-blogs.php`	Restores the current blog, after calling switch_to_blog() .
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.
get_option()`wp-includes/option.php`	Retrieves an option value based on an option name.

Show 3 more Show less

Used by	Description
wpmu_new_site_admin_notification()`wp-includes/ms-functions.php`	Notifies the Multisite network administrator that a new site was created.
get_admin_url()`wp-includes/link-template.php`	Retrieves the URL to the admin area for a given site.
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.

Changelog

Version	Description
3.0.0	Introduced.

User Contributed Notes

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: 17You must log in to vote on the helpfulness of this note
```
<?php echo get_site_url(); ?>
```
Results in the full site URL being displayed:

http://www.example.com
Log in to add feedback
Skip to note 7 content

Borek Bernard 8 years ago

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

The value is without a trailing slash, e.g., https://www.example.com, not https://www.example.com/.

Log in to add feedback
Skip to note 8 content

Anthony Eden 3 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 7You must log in to vote on the helpfulness of this note
To get just the hostname/domain component of the Site URL (without paths, schema, etc.) you could use the following:
```
echo parse_url( get_site_url(), PHP_URL_HOST );
```
- Does not work for me with latest version of WordPress. Perhaps preg_replace('#^https?://#', '', get_site_url()) is a better alternative?
  
  Watermark Branding 10 months ago
Log in to add feedback
Skip to note 9 content

tazotodua 5 years ago

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

if WP installed into subfolder, returns:

https://www.example.com/sub/folder

Log in to add feedback
Skip to note 10 content

klaudiom 8 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
```
$url = get_site_url(null, '/wp-content/themes/', 'https');
```
When you need to pass the scheme as well.
Log in to add feedback

get_site_url( int|null $blog_id = null, string $path = ”, string|null $scheme = null ): string

In this article