get_home_url()
最后更新于:2021-11-26 09:12:56
get_home_url( int|null$blog_id=null, string$path=”, string|null$scheme=null)Retrieves the URL for a given site where the front end is accessible.
参数
- $blog_id
-
(int|null) (Optional) Site ID. Default null (current site).
Default value: null
- $path
-
(string) (Optional) Path relative to the home URL.
Default value: ”
- $scheme
-
(string|null) (Optional) Scheme to give the home URL context. Accepts ‘http’, ‘https’, ‘relative’, ‘rest’, or null.
Default value: null
响应
(string) Home URL link with optional path appended.
源文件
文件: gc-includes/link-template.php
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 );
}