get_home_url() - WordPress 函数参考中文文档

返回介绍

get_home_url()

发布于 2017-09-10 字数4823 浏览 990 评论 0

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

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


描述

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.


参数

$blog_id

(int)
(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.


源代码

File: wp-includes/link-template.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 );
}

更新日志

Version 描述
3.0.0 Introduced.

More Information

Basic Usage


<?php echo get_home_url(); ?>

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


相关函数

Uses

  • wp-includes/load.php:
    is_multisite()
  • wp-includes/load.php:
    is_admin()
  • wp-includes/load.php:
    is_ssl()
  • wp-includes/link-template.php:
    set_url_scheme()
  • wp-includes/link-template.php:
    home_url
  • wp-includes/plugin.php:
    apply_filters()
  • wp-includes/option.php:
    get_option()
  • wp-includes/ms-blogs.php:
    switch_to_blog()
  • wp-includes/ms-blogs.php:
    restore_current_blog()
  • Show 4 more uses
    Hide more uses


Used By

  • wp-includes/rest-api.php:
    get_rest_url()
  • wp-includes/embed.php:
    get_oembed_response_data()
  • wp-admin/includes/class-wp-ms-sites-list-table.php:
    WP_MS_Sites_List_Table::handle_row_actions()
  • wp-admin/includes/class-wp-ms-users-list-table.php:
    WP_MS_Users_List_Table::column_blogs()
  • wp-signup.php:
    signup_another_blog()
  • wp-admin/includes/ms.php:
    _access_denied_splash()
  • wp-admin/includes/ms.php:
    choose_primary_blog()
  • wp-admin/includes/ms.php:
    confirm_delete_users()
  • wp-admin/includes/options.php:
    options_general_add_js()
  • wp-includes/link-template.php:
    home_url()
  • wp-includes/link-template.php:
    get_post_type_archive_link()
  • wp-includes/class-wp-admin-bar.php:
    WP_Admin_Bar::initialize()
  • wp-includes/admin-bar.php:
    wp_admin_bar_site_menu()
  • wp-includes/admin-bar.php:
    wp_admin_bar_my_sites_menu()
  • wp-includes/ms-functions.php:
    install_blog()
  • Show 10 more used by
    Hide more used by


User Contributed Notes

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

目前还没有任何评论,快来抢沙发吧!