Docs: Clarify descriptions for home_url()
and get_home_url()
on the true effect of the $scheme
parameter.
Part props thomaswm. Props stevenlinx. Fixes #36468. git-svn-id: https://develop.svn.wordpress.org/trunk@39054 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
parent
8d94a5ae26
commit
ee84a7a31a
@ -2954,9 +2954,9 @@ function get_shortcut_link() {
|
|||||||
/**
|
/**
|
||||||
* Retrieves the URL for the current site where the front end is accessible.
|
* Retrieves the URL for the current site where the front end is accessible.
|
||||||
*
|
*
|
||||||
* Returns the 'home' option with the appropriate protocol, 'https' if
|
* Returns the 'home' option with the appropriate protocol. The protocol will be 'https'
|
||||||
* is_ssl() and 'http' otherwise. If `$scheme` is 'http' or 'https',
|
* if is_ssl() evaluates to true; otherwise, it will be the same as the 'home' option.
|
||||||
* `is_ssl()` is overridden.
|
* If `$scheme` is 'http' or 'https', is_ssl() is overridden.
|
||||||
*
|
*
|
||||||
* @since 3.0.0
|
* @since 3.0.0
|
||||||
*
|
*
|
||||||
@ -2972,9 +2972,9 @@ function home_url( $path = '', $scheme = null ) {
|
|||||||
/**
|
/**
|
||||||
* Retrieves the URL for a given site where the front end is accessible.
|
* Retrieves the URL for a given site where the front end is accessible.
|
||||||
*
|
*
|
||||||
* Returns the 'home' option with the appropriate protocol, 'https' if
|
* Returns the 'home' option with the appropriate protocol. The protocol will be 'https'
|
||||||
* is_ssl() and 'http' otherwise. If `$scheme` is 'http' or 'https',
|
* if is_ssl() evaluates to true; otherwise, it will be the same as the 'home' option.
|
||||||
* `is_ssl()` is overridden.
|
* If `$scheme` is 'http' or 'https', is_ssl() is overridden.
|
||||||
*
|
*
|
||||||
* @since 3.0.0
|
* @since 3.0.0
|
||||||
*
|
*
|
||||||
|
Loading…
Reference in New Issue
Block a user