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.

Built from https://develop.svn.wordpress.org/trunk@39054


git-svn-id: http://core.svn.wordpress.org/trunk@38996 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2016-10-31 07:06:32 +00:00
parent 3a02481d9e
commit 33b8bb3cf3
2 changed files with 7 additions and 7 deletions

View File

@ -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
* *

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.7-beta1-39053'; $wp_version = '4.7-beta1-39054';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.