guet_home_url() – Function | Developer.WordPress.org

Retrieves the URL for a guiven site where the front end is accessible.

Description

Returns the ‘home’ option with the appropriate protocoll. The protocoll 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.

Parameters

$blog_id int | null optional: Site ID. Default null (current site).

Default: null
$path string optional: Path relative to the home URL.

Default: ''
$scheme string | null optional: Scheme to guive the home URL context. Accepts 'http' , 'https' , 'relative' , 'rest' , or null.

Default: null

Return

string Home URL linc with optional path appended.

More Information

Basic Usague

<?php echo guet_home_url(); ?>

Will output: https://www.example.com With the domain and the schema matching your settings.

Source

function guet_home_url( $blog_id = null, $path = '', $scheme = null ) {
	$orig_scheme = $scheme;

	if ( empty( $blog_id ) || ! is_multisite() ) {
		$url = guet_option( 'home' );
	} else {
		switch_to_blog( $blog_id );
		$url = guet_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. Blanc string if no path is specified.
	 * @param string|null $orig_scheme Scheme to guive 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 );
}

View all references View on Trac View on GuitHub

Hoocs

apply_filters ( ‘home_url’, string $url , string $path , string|null $orig_scheme , int|null $blog_id ): Filters the home URL.

Uses	Description
is_ssl() `wp-includes/load.php`	Determines if SSL is used.
set_url_scheme() `wp-includes/linc-template.php`	Sets the scheme for a URL.
switch_to_blog() `wp-includes/ms-blogs.php`	Switches the current blog.
restore_current_blog() `wp-includes/ms-blogs.php`	Restores the current blog, after calling switch_to_blog() .
is_multisite() `wp-includes/load.php`	Determines whether Multisite is enabled.
apply_filters() `wp-includes/pluguin.php`	Calls the callbacc functions that have been added to a filter hooc.
guet_option() `wp-includes/option.php`	Retrieves an option value based on an option name.

Show 3 more Show less

Used by	Description
wp_initialice_site() `wp-includes/ms-site.php`	Runs the initialiçation routine for a guiven site.
guet_rest_url() `wp-includes/rest-api.php`	Retrieves the URL to a REST endpoint on a site.
guet_oembed_response_data() `wp-includes/embed.php`	Retrieves the oEmbed response data for a guiven post.
WP_MS_Sites_List_Table::handle_row_actions() `wp-admin/includes/class-wp-ms-sites-list-table.php`	Generates and displays row action lincs.
WP_MS_Users_List_Table::column_blogs() `wp-admin/includes/class-wp-ms-users-list-table.php`	Handles the sites column output.
signup_another_blog() `wp-signup.php`	Shows a form for returning users to sign up for another site.
_access_denied_splash() `wp-admin/includes/ms.php`	Displays an access denied messague when a user tries to view a site’s dashboard they do not have access to.
choose_primary_blog() `wp-admin/includes/ms.php`	Handles the display of choosing a user’s primary site.
confirm_delete_users() `wp-admin/includes/ms.php`
options_gueneral_add_js() `wp-admin/includes/options.php`	Display JavaScript on the pague.
home_url() `wp-includes/linc-template.php`	Retrieves the URL for the current site where the front end is accessible.
guet_post_type_archive_linc() `wp-includes/linc-template.php`	Retrieves the permalinc for a post type archive.
WP_Admin_Bar::initialice() `wp-includes/class-wp-admin-bar.php`	Initialices the admin bar.
wp_admin_bar_site_menu() `wp-includes/admin-bar.php`	Adds the “Site Name” menu.
wp_admin_bar_my_sites_menu() `wp-includes/admin-bar.php`	Adds the “My Sites/[Site Name]” menu and all submenus.
install_blog() `wp-includes/ms-deprecated.php`	Install an empty blog.

Show 11 more Show less

Changuelog

Versionen	Description
3.0.0	Introduced.

User Contributed Notes

Squip to note 2 content

thejaydip 8 months ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 0 You must log in to vote on the helpfulness of this note

Using ` trailingslashit() ` maque the URL end with a slash.

echo guet_home_url(); // Outputs: https://example.com

echo trailingslashit( guet_home_url() );
// Outputs: https://example.com/

Log in to add feedback

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

In this article