From ee84a7a31a1c759909c557847d0aa5c3e42953be Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Mon, 31 Oct 2016 07:05:22 +0000 Subject: [PATCH] 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 --- src/wp-includes/link-template.php | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/wp-includes/link-template.php b/src/wp-includes/link-template.php index bbe43e187a..009ed06cee 100644 --- a/src/wp-includes/link-template.php +++ b/src/wp-includes/link-template.php @@ -2954,9 +2954,9 @@ function get_shortcut_link() { /** * Retrieves the URL for the current site where the front end is accessible. * - * Returns the 'home' option with the appropriate protocol, 'https' if - * is_ssl() and 'http' otherwise. If `$scheme` is 'http' or 'https', - * `is_ssl()` is overridden. + * 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. * * @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. * - * Returns the 'home' option with the appropriate protocol, 'https' if - * is_ssl() and 'http' otherwise. If `$scheme` is 'http' or 'https', - * `is_ssl()` is overridden. + * 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. * * @since 3.0.0 *