检索可以访问前端的给定站点的URL。

原型

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

描述

使用适当的协议返回“home”选项。如果is_ssl()的计算结果为true,则协议将为“https”;否则,它将与’home’选项相同。如果$ scheme为’http’或’https’,则重写is_ssl()。

参数

$blog_id (int) (Optional)  网站ID。默认为null(当前站点)。

$path (string) (Optional)  相对于主URL的路径。

$scheme (string|null) (Optional)  提供主URL上下文的方案。接受’http’,‘https’,‘relative’,‘rest’或null。

返回值

(string)  附加了可选路径的主页URL链接。

源文件

路径:wp-includes/link-template.php

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
<?php
...
function get_home_url( $blog_id = null, $path = '', $scheme = null ) {
	global $pagenow;

	$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' ) ) ) {
		if ( is_ssl() && ! is_admin() && 'wp-login.php' !== $pagenow )
			$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 );
}

...
?>

其他

英文文档:https://developer.wordpress.org/reference/functions/get_home_url/