Changeset 50054 for branches/5.6/src/wp-includes/load.php

Timestamp:

01/28/2021 11:05:23 AM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Update documentation for wp_is_site_protected_by_basic_auth() per the documentation standards.

Follow-up to [49752], [50006].

Merges [50053] to the 5.6 branch.
See #52066.

Location:

branches/5.6

Files:

• . (modified) (1 prop)
• src/wp-includes/load.php (modified) (2 diffs)

branches/5.6/src/wp-includes/load.php

@@ -1690 +1690 @@
  * 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.
- *
- * Currently, this is only used by Application Passwords to prevent a conflict since it also utilizes 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.
+ *
+ * Currently, this is only used by Application Passwords to prevent a conflict since it also utilizes
+ * Basic Auth.
  *
  * @since 5.6.1
@@ -1700 +1701 @@
  * @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 = '' ) {