get_home_url( int|null $blog_id = null, string $path = '', string|null $scheme = null )
Retrieves the URL for a given site where the front end is accessible.
Description
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.
Parameters
- $blog_id
-
(int|null) (Optional) Site ID. Default null (current site).
Default value: null
- $path
-
(string) (Optional) Path relative to the home URL.
Default value: ''
- $scheme
-
(string|null) (Optional) Scheme to give the home URL context. Accepts 'http', 'https', 'relative', 'rest', or null.
Default value: null
Return
(string) Home URL link with optional path appended.
More Information
Basic Usage
<?php echo get_home_url(); ?>
Will output: https://www.example.com
With the domain and the schema matching your settings.
Source
File: wp-includes/link-template.php
function get_home_url( $blog_id = null, $path = '', $scheme = null ) { $orig_scheme = $scheme; if ( empty( $blog_id ) || ! is_multisite() ) { $url = get_option( 'home' ); } else { switch_to_blog( $blog_id ); $url = get_option( 'home' ); restore_current_blog(); } if ( ! in_array( $scheme, array( 'http', 'https', 'relative' ), true ) ) { if ( is_ssl() ) { $scheme = 'https'; } else { $scheme = parse_url( $url, PHP_URL_SCHEME ); } } $url = set_url_scheme( $url, $scheme ); if ( $path && is_string( $path ) ) { $url .= '/' . ltrim( $path, '/' ); } /** * Filters the home URL. * * @since 3.0.0 * * @param string $url The complete home URL including scheme and path. * @param string $path Path relative to the home URL. Blank string if no path is specified. * @param string|null $orig_scheme Scheme to give the home URL context. Accepts 'http', 'https', * 'relative', 'rest', or null. * @param int|null $blog_id Site ID, or null for the current site. */ return apply_filters( 'home_url', $url, $path, $orig_scheme, $blog_id ); }
Changelog
Version | Description |
---|---|
3.0.0 | Introduced. |
© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_home_url