get_home_url() │ WP 3.0.0

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

0

#1 Let's display the blog's URL 

<?php echo get_home_url(); ?>

http://example.com

0

#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.

get_home_url() code WP 6.3

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

Link (URL)

Site Options (settings)

Links (URL)