云策 WordPress 开发者社区

函数文档

get_home_url()

查看官方原文 ↗
💡 云策文档标注

概述

get_home_url() 函数用于检索网站前端可访问的 URL，支持多站点环境，并可指定协议和附加路径。它基于 'home' 选项生成 URL，并可通过过滤器进行自定义。

关键要点

  • 函数返回网站的首页 URL，默认使用当前站点，支持通过 $blog_id 参数指定多站点中的特定站点。
  • 协议处理：默认根据 is_ssl() 判断使用 HTTPS 或 HTTP，但可通过 $scheme 参数强制指定 'http'、'https'、'relative' 或 'rest'。
  • 路径附加：通过 $path 参数可在 URL 后附加相对路径，函数会自动处理斜杠。
  • 过滤器：返回的 URL 可通过 'home_url' 过滤器进行修改，参数包括 $url、$path、$orig_scheme 和 $blog_id。
  • 相关函数：涉及 is_ssl()、set_url_scheme()、switch_to_blog() 等，用于支持其功能实现。

代码示例

// 基本用法：输出当前站点的首页 URL，如 https://www.example.com
echo get_home_url();

// 使用 trailingslashit() 确保 URL 以斜杠结尾
echo trailingslashit( get_home_url() ); // 输出: https://example.com/
📄 原文内容

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

Description

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.

Parameters

$blog_idint|nulloptional
Site ID. Default null (current site).

Default:null

$pathstringoptional
Path relative to the home URL. Default empty.
$schemestring|nulloptional
Scheme to give the home URL context. Accepts 'http', 'https', 'relative', 'rest', or null.

Default:null

Return

string Home URL link with optional path appended.

More Information

Basic Usage

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

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

View all references View on Trac View on GitHub

Hooks

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/link-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/plugin.php

Calls the callback functions that have been added to a filter hook.
get_option()wp-includes/option.php

Retrieves an option value based on an option name.

Show 3 moreShow less

Used by Description
wp_initialize_site()wp-includes/ms-site.php

Runs the initialization routine for a given site.
get_rest_url()wp-includes/rest-api.php

Retrieves the URL to a REST endpoint on a site.
get_oembed_response_data()wp-includes/embed.php

Retrieves the oEmbed response data for a given post.
WP_MS_Sites_List_Table::handle_row_actions()wp-admin/includes/class-wp-ms-sites-list-table.php

Generates and displays row action links.
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 message 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_general_add_js()wp-admin/includes/options.php

Display JavaScript on the page.
home_url()wp-includes/link-template.php

Retrieves the URL for the current site where the front end is accessible.
get_post_type_archive_link()wp-includes/link-template.php

Retrieves the permalink for a post type archive.
WP_Admin_Bar::initialize()wp-includes/class-wp-admin-bar.php

Initializes 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 moreShow less

Changelog

Version Description
3.0.0 Introduced.

User Contributed Notes