home_url( string $path = '', string|null $scheme = null ): string

Description

Parameters

$pathstringoptional

Path relative to the home URL. Default empty.Default: ''

$schemestring|nulloptional

Scheme to give the home URL context. Accepts 'http', 'https', 'relative', 'rest', or null. Default null.Default: null

Return

string

Home URL link with optional path appended.

Uses · 1

• get_home_url()Retrieves the URL for a given site where the front end is accessible.

Used by · 50

• Custom_Background::admin_page()Displays the custom background page.
• Custom_Image_Header::step_1()Displays first step of custom header image page.
• WP::parse_request()Parses the request to find the correct WordPress query.
• WP_Admin_Bar::initialize()Initializes the admin bar.
• WP_Automatic_Updater::has_fatal_error()Performs a loopback request to check for potential fatal errors.
• WP_Automatic_Updater::send_debug_email()Prepares and sends an email of a full log of background update results, useful for debugging and geekery.
• WP_Automatic_Updater::send_email()Sends an email upon the completion or failure of a background core update.
• WP_Automatic_Updater::send_plugin_theme_email()Sends an email upon the completion or failure of a plugin or theme background update.
• WP_Community_Events::get_events()Gets data about events near a particular location.
• WP_Customize_Manager::customize_pane_settings()Prints JavaScript settings for parent window.
• WP_Customize_Manager::customize_preview_settings()Prints JavaScript settings for preview frame.
• WP_Customize_Manager::get_allowed_urls()Gets URLs allowed to be previewed.

Source

View on Trac ↗View on GitHub ↗

3441function home_url( $path = '', $scheme = null ) {3442	return get_home_url( null, $path, $scheme );3443}

History

Introduced in 3.0.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/link-template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.