site_url() – Function | Developer.WordPress.org

Retrieves the URL for the current 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

$pathstringoptional: Path relative to the site URL.
Default:''
$schemestring|nulloptional: Scheme to give the site URL context. See set_url_scheme() .
More Arguments from set_url_scheme( … $scheme )
Scheme to give $url. Currently 'http', 'https', 'login', 'login_post', 'admin', 'relative', 'rest', 'rpc', or null.
Default:null

Return

string Site URL link with optional path appended.

Source

function site_url( $path = '', $scheme = null ) {
	return get_site_url( null, $path, $scheme );
}

View all references View on Trac View on GitHub

Uses	Description
get_site_url()`wp-includes/link-template.php`	Retrieves the URL for a given site where WordPress application files (e.g. wp-blog-header.php or the wp-admin/ folder) are accessible.

Used by	Description
wp_is_local_html_output()`wp-includes/https-detection.php`	Checks whether a given HTML string is likely an output from this WordPress site.
wp_should_replace_insecure_home_url()`wp-includes/https-migration.php`	Checks whether WordPress should replace old HTTP URLs to the site with their HTTPS counterpart.
WP_Site_Health::can_perform_loopback()`wp-admin/includes/class-wp-site-health.php`	Runs a loopback test on the site.
wp_print_request_filesystem_credentials_modal()`wp-admin/includes/file.php`	Prints the filesystem credentials modal when needed.
spawn_cron()`wp-includes/cron.php`	Sends a request to run cron through HTTP request that doesn’t halt page loading.
get_theme_root_uri()`wp-includes/theme.php`	Retrieves URI for themes directory.
translate_smiley()`wp-includes/formatting.php`	Converts one smiley code to the icon graphic file equivalent.
rsd_link()`wp-includes/general-template.php`	Displays the link to the Really Simple Discovery service endpoint.
get_bloginfo()`wp-includes/general-template.php`	Retrieves information about the current site.
wp_logout_url()`wp-includes/general-template.php`	Retrieves the logout URL.
wp_login_url()`wp-includes/general-template.php`	Retrieves the login URL.
wp_registration_url()`wp-includes/general-template.php`	Returns the URL that allows the user to register on the site.
wp_login_form()`wp-includes/general-template.php`	Provides a simple login form for use anywhere within WordPress.
do_robots()`wp-includes/functions.php`	Displays the default robots.txt file content.
WP_Widget_RSS::widget()`wp-includes/widgets/class-wp-widget-rss.php`	Outputs the content for the current RSS widget instance.
includes_url()`wp-includes/link-template.php`	Retrieves the URL to the includes directory.
network_site_url()`wp-includes/link-template.php`	Retrieves the site URL for the current network.
get_the_password_form()`wp-includes/post-template.php`	Retrieves protected post password form content.
WP_Rewrite::mod_rewrite_rules()`wp-includes/class-wp-rewrite.php`	Retrieves mod_rewrite-formatted rewrite rules to write to .htaccess.
wp_redirect_admin_locations()`wp-includes/canonical.php`	Redirects a variety of shorthand URLs to the admin.
newblog_notify_siteadmin()`wp-includes/ms-functions.php`	Notifies the network admin that a new site has been activated.
wpmu_signup_user_notification()`wp-includes/ms-functions.php`	Sends a confirmation request email to a user when they sign up for a new user account (without signing up for a site at the same time). The user account will not become active until the confirmation link is clicked.
wp_xmlrpc_server::blogger_getUsersBlogs()`wp-includes/class-wp-xmlrpc-server.php`	Retrieves blogs that user owns.
wp_xmlrpc_server::wp_getUsersBlogs()`wp-includes/class-wp-xmlrpc-server.php`	Retrieves the blogs of the user.
comment_form()`wp-includes/comment-template.php`	Outputs a complete commenting form for use within a template.
wp_default_styles()`wp-includes/script-loader.php`	Assigns default styles to $styles object.
wp_default_scripts()`wp-includes/script-loader.php`	Registers all WordPress scripts.

Show 22 more Show less

Changelog

Version	Description
3.0.0	Introduced.

User Contributed Notes

Skip to note 3 content

Codex 9 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
Examples
```
$url = site_url();
echo $url;
```
Output: http://www.example.com or http://www.example.com/wordpress

(Note the lack of a trailing slash)
```
$url = site_url( '/secrets/', 'https' );
echo $url;
```
Output: https://www.example.com/secrets/ or https://www.example.com/wordpress/secrets/
Log in to add feedback
Skip to note 4 content

mirgcire 7 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

The contributed example is unclear because it states that the result is one of two options, but no information is given to determine which option to expect. Are we to assume it is random, and therefore must filter out the spurious occurrences of “wordpress”?
- While unclear, the example does reflect the true nature of the function per the description above: “Retrieves the URL for the current site where WordPress application files (e.g. wp-blog-header.php or the wp-admin/ folder) are accessible.” The situation where “/wordpress/” may occur in the URL arises when WordPress is installed in a directory other than public_html (or whatever web root your host uses). This can be useful if you’re trying to achieve that end. If instead, you are trying to reliably access the URL of the home page of the site, be sure to see home_url() . https://developer.wordpress.org/reference/functions/home_url/
  
  jcleaveland 5 years ago
- The /wordpress/ portion on the examples above is the directory of your WordPress installation in case it’s not installed in the domain root level, which is the first output in the example.
  
  Daniel Maier 3 years ago
Log in to add feedback

site_url( string $path = ”, string|null $scheme = null ): string

In this article

Description

Parameters

Return

Source

Changelog

User Contributed Notes

site_url( string $path = ”, string|null $scheme = null ): string

In this article

Description

Parameters

Return

Source

Related

Changelog

User Contributed Notes