wp_auth_check_load

Filters whether to load the authentication check.

Description

apply_filters( 'wp_auth_check_load', (bool) $show, (WP_Screen) $screen ); 

Passing a falsey value to the filter will effectively short-circuit loading the authentication check.

Parameters (2)

0. $show (bool)
Whether to load the authentication check.
1. $screen (WP_Screen)
The current screen object.

Usage

To run the hook, copy the example below.
  1. $show = apply_filters( 'wp_auth_check_load', $show, $screen ); 
  2.  
  3. if ( !empty( $show ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the wp_auth_check_load callback 
  2. function filter_wp_auth_check_load( $show, $screen ) { 
  3. // make filter magic happen here... 
  4. return $show
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'wp_auth_check_load', 'filter_wp_auth_check_load', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'wp_auth_check_load', 'filter_wp_auth_check_load', 10, 2 ); 

Defined (1)

The filter is defined in the following location(s).

/wp-includes/functions.php  
  1. if ( apply_filters( 'wp_auth_check_load', $show, $screen ) ) {