wpseek.com
A WordPress-centric search engine for devs and theme authors



get_home_url › WordPress Function

Since3.0.0
Deprecatedn/a
› get_home_url ( $blog_id = null, $path = '', $scheme = null )
Parameters: (3)
  • (int|null) $blog_id Optional. Site ID. Default null (current site).
    Required: No
    Default: null
  • (string) $path Optional. Path relative to the home URL. Default empty.
    Required: No
    Default: (empty)
  • (string|null) $scheme Optional. Scheme to give the home URL context. Accepts 'http', 'https', 'relative', 'rest', or null. Default null.
    Required: No
    Default: null
Returns:
  • (string) Home URL link with optional path appended.
Defined at:
Codex:

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.


Related Functions: home_url, network_home_url, get_rest_url, get_site_url, get_admin_url

Source 

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