From d8b7a219b3436a34106080bb29eea7e03bdca516 Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Thu, 28 Jan 2021 11:04:08 +0000 Subject: [PATCH] Docs: Update documentation for `wp_is_site_protected_by_basic_auth()` per the documentation standards. Follow-up to [49752], [50006]. See #52066. git-svn-id: https://develop.svn.wordpress.org/trunk@50053 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/load.php | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/src/wp-includes/load.php b/src/wp-includes/load.php index 15feeeaf3c..a68e6db435 100644 --- a/src/wp-includes/load.php +++ b/src/wp-includes/load.php @@ -1689,19 +1689,20 @@ function wp_is_xml_request() { /** * Checks if this site is protected by HTTP Basic Auth. * - * At the moment, this merely checks for the present of Basic Auth credentials. Therefore, calling this function - * with a context different from the current context may give inaccurate results. In a future release, this - * evaluation may be made more robust. + * At the moment, this merely checks for the present of Basic Auth credentials. Therefore, calling + * this function with a context different from the current context may give inaccurate results. + * In a future release, this evaluation may be made more robust. * - * Currently, this is only used by Application Passwords to prevent a conflict since it also utilizes Basic Auth. + * Currently, this is only used by Application Passwords to prevent a conflict since it also utilizes + * Basic Auth. * * @since 5.6.1 * * @global string $pagenow The current page. * - * @param string $context The context to check for protection. Accepts 'login', 'admin', and 'front'. Defaults to the current context. - * - * @return bool + * @param string $context The context to check for protection. Accepts 'login', 'admin', and 'front'. + * Defaults to the current context. + * @return bool Whether the site is protected by Basic Auth. */ function wp_is_site_protected_by_basic_auth( $context = '' ) { global $pagenow;