WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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.
Built from https://develop.svn.wordpress.org/branches/5.6@50054


git-svn-id: http://core.svn.wordpress.org/branches/5.6@49755 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2021-01-28 11:06:58 +00:00
parent c08b929a9e
commit dfb8d47c85
2 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
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. * 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 * At the moment, this merely checks for the present of Basic Auth credentials. Therefore, calling
* with a context different from the current context may give inaccurate results. In a future release, this * this function with a context different from the current context may give inaccurate results.
* evaluation may be made more robust. * 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 * @since 5.6.1
* *
* @global string $pagenow The current page. * @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. * @param string $context The context to check for protection. Accepts 'login', 'admin', and 'front'.
* * Defaults to the current context.
* @return bool * @return bool Whether the site is protected by Basic Auth.
*/ */
function wp_is_site_protected_by_basic_auth( $context = '' ) { function wp_is_site_protected_by_basic_auth( $context = '' ) {
global $pagenow; global $pagenow;

2
wp-includes/version.php
View File

@ -13,7 +13,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.6.1-alpha-50052'; $wp_version = '5.6.1-alpha-50054';
/** /**
* 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.