wp_is_site_protected_by_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 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.
Hooks from the function
Returns
true|false
. Whether the site is protected by Basic Auth.
Usage
wp_is_site_protected_by_basic_auth( $context );
- $context(string)
- The context to check for protection. Accepts 'login', 'admin', and 'front'.
Default: current context
Notes
- Global. String. $pagenow The filename of the current screen.
Changelog
Since 5.6.1 | Introduced. |
wp_is_site_protected_by_basic_auth() wp is site protected by basic auth code WP 6.8.1
function wp_is_site_protected_by_basic_auth( $context = '' ) { global $pagenow; if ( ! $context ) { if ( 'wp-login.php' === $pagenow ) { $context = 'login'; } elseif ( is_admin() ) { $context = 'admin'; } else { $context = 'front'; } } $is_protected = ! empty( $_SERVER['PHP_AUTH_USER'] ) || ! empty( $_SERVER['PHP_AUTH_PW'] ); /** * Filters whether a site is protected by HTTP Basic Auth. * * @since 5.6.1 * * @param bool $is_protected Whether the site is protected by Basic Auth. * @param string $context The context to check for protection. One of 'login', 'admin', or 'front'. */ return apply_filters( 'wp_is_site_protected_by_basic_auth', $is_protected, $context ); }