get_home_url()
Retrieves the URL for a given site where the front end is accessible.
Returns the 'home' option with the appropriate protocol. The protocol will be 'https' if is_ssl() evaluates to true; otherwise, it will be the same as the 'home' option. If $scheme is 'http' or 'https', is_ssl() is overridden.
Used By: get_rest_url(), home_url()
1 time — 0.000065 sec (very fast) | 50000 times — 0.39 sec (very fast) | PHP 7.1.2, WP 4.7.3
Hooks from the function
Return
String
. Home URL link with optional path appended.
Usage
get_home_url( $blog_id, $path, $scheme );
- $blog_id(int|null)
- Site ID.
Default: null (current site) - $path(string)
- Path relative to the home URL.
Default: '' - $scheme(string|null)
- Scheme to give the home URL context. Accepts 'http', 'https', 'relative', 'rest', or null.
Default: null
Examples
#1 Let's display the blog's URL
<?php echo get_home_url(); ?>
http://example.com
#2 Let's set up a path and a scheme
<?php echo get_home_url( null, 'wp-admin/', 'https' ); ?>
https://example.com/wp-admin/
Changelog
Since 3.0.0 | Introduced. |