get_home_url( int|null $blog_id = null, string $path = '', string|null $scheme = null ): string

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$blog_idint|nulloptional

Site ID. Default null (current site).Default: null

$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 value

string

Home URL link with optional path appended.

Performance profile

How much work a call to get_home_url() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Moderate

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

27–50

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 57.

Plugin surface

1 hook

Third-party callbacks on 'home_url' run inside this call, and their cost is not bounded by anything here.

Called by

17

17 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• optionoption read or writeget_option()called directly
• hookthird-party callbacksapply_filters()called directly
• cacheobject cachewp_cache_get()one call below get_home_url()
• serializeserialisationmaybe_unserialize()one call below get_home_url()

Further down the call graph this can also reach query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 18 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost get_home_url() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while get_home_url() runs, in this order:

1. 1
   apply_filters( home_url )filterline 3496 (+36 into the body)

   Filters the home URL.

Uses · 7

• is_multisite()Determines whether Multisite is enabled.
• get_option()Retrieves an option value based on an option name.
• switch_to_blog()Switches the current blog.
• restore_current_blog()Restores the current blog, after calling switch_to_blog().
• is_ssl()Determines if SSL is used.
• set_url_scheme()Sets the scheme for a URL.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 17

• WP_Admin_Bar::initialize()Initializes the admin bar.
• WP_MS_Sites_List_Table::handle_row_actions()Generates and displays row action links.
• WP_MS_Users_List_Table::column_blogs()Handles the sites column output.
• _access_denied_splash()Displays an access denied message when a user tries to view a site's dashboard they do not have access to.
• choose_primary_blog()Handles the display of choosing a user's primary site.
• confirm_delete_users()
• get_oembed_response_data()Retrieves the oEmbed response data for a given post.
• get_post_type_archive_link()Retrieves the permalink for a post type archive.
• get_rest_url()Retrieves the URL to a REST endpoint on a site.
• home_url()Retrieves the URL for the current site where the front end is accessible.
• install_blog()Install an empty blog.
• options_general_add_js()Display JavaScript on the page.

Source code

View on Trac ↗View on GitHub ↗

3460function get_home_url( $blog_id = null, $path = '', $scheme = null ) {3461	$orig_scheme = $scheme;3462 3463	if ( empty( $blog_id ) || ! is_multisite() ) {3464		$url = get_option( 'home' );3465	} else {3466		switch_to_blog( $blog_id );3467		$url = get_option( 'home' );3468		restore_current_blog();3469	}3470 3471	if ( ! in_array( $scheme, array( 'http', 'https', 'relative' ), true ) ) {3472		if ( is_ssl() ) {3473			$scheme = 'https';3474		} else {3475			$scheme = parse_url( $url, PHP_URL_SCHEME );3476		}3477	}3478 3479	$url = set_url_scheme( $url, $scheme );3480 3481	if ( $path && is_string( $path ) ) {3482		$url .= '/' . ltrim( $path, '/' );3483	}3484 3485	/**3486	 * Filters the home URL.3487	 *3488	 * @since 3.0.03489	 *3490	 * @param string      $url         The complete home URL including scheme and path.3491	 * @param string      $path        Path relative to the home URL. Blank string if no path is specified.3492	 * @param string|null $orig_scheme Scheme to give the home URL context. Accepts 'http', 'https',3493	 *                                 'relative', 'rest', or null.3494	 * @param int|null    $blog_id     Site ID, or null for the current site.3495	 */3496	return apply_filters( 'home_url', $url, $path, $orig_scheme, $blog_id );3497}

Changelog

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