WordPress.org

Make WordPress Core

Changeset 50053


Ignore:
Timestamp:
01/28/2021 11:04:08 AM (10 months ago)
Author:
SergeyBiryukov
Message:

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

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

See #52066.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/load.php

    r50006 r50053  
    16901690 * Checks if this site is protected by HTTP Basic Auth.
    16911691 *
    1692  * At the moment, this merely checks for the present of Basic Auth credentials. Therefore, calling this function
    1693  * with a context different from the current context may give inaccurate results. In a future release, this
    1694  * evaluation may be made more robust.
    1695  *
    1696  * Currently, this is only used by Application Passwords to prevent a conflict since it also utilizes Basic Auth.
     1692 * At the moment, this merely checks for the present of Basic Auth credentials. Therefore, calling
     1693 * this function with a context different from the current context may give inaccurate results.
     1694 * In a future release, this evaluation may be made more robust.
     1695 *
     1696 * Currently, this is only used by Application Passwords to prevent a conflict since it also utilizes
     1697 * Basic Auth.
    16971698 *
    16981699 * @since 5.6.1
     
    17001701 * @global string $pagenow The current page.
    17011702 *
    1702  * @param string $context The context to check for protection. Accepts 'login', 'admin', and 'front'. Defaults to the current context.
    1703  *
    1704  * @return bool
     1703 * @param string $context The context to check for protection. Accepts 'login', 'admin', and 'front'.
     1704 *                        Defaults to the current context.
     1705 * @return bool Whether the site is protected by Basic Auth.
    17051706 */
    17061707function wp_is_site_protected_by_basic_auth( $context = '' ) {
Note: See TracChangeset for help on using the changeset viewer.