vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2025-10-16 12:05:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

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

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

See #52066.

git-svn-id: https://develop.svn.wordpress.org/trunk@50053 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2021-01-28 11:04:08 +00:00
parent 919019865a
commit d8b7a219b3
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/wp-includes/load.php
View File

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