WordPress.org

Languages: English • 日本語 (Add your language)

Description

The home_url template tag retrieves the home URL for the current site, optionally with the $path argument appended. The function determines the appropriate protocol, "https" if is_ssl() and "http" otherwise. If the $scheme argument is "http" or "https" the is_ssl() check is overridden.

In case of WordPress Network Setup, use network_home_url() instead.

Usage

<?php home_url( $path, $scheme ); ?>

Default Usage

<?php echo esc_url( home_url( '/' ) ); ?>

Parameters

$path

(string) (optional) Path relative to the home URL.

Default: None

$scheme

(string) (optional) Scheme to use for the home URL. Currently, only "http", "https" and "relative" are supported.

Default: null

Return

(string) 

Home URL with the optional $path argument appended.

Example

$url = home_url();
echo esc_url( $url );

Output: http://www.example.com

(Note the lack of a trailing slash)

$url = home_url( '/' );
echo esc_url( $url );

Output: http://www.example.com/

$url = home_url( '/', 'https' );
echo esc_url( $url );

Output: https://www.example.com/

$url = home_url( 'example', 'relative' );
echo esc_url( $url );

Output: /example

Notes

• Uses get_home_url()
• Uses the 'home' option

Changelog

• Since: 3.0.0

Source Code

home_url() is located in wp-includes/link-template.php.

Related