W3cubDocs

/WordPress

wp_auth_check_load()

Load the auth check for monitoring whether the user is still logged in.

Description

Can be disabled with remove_action( ‘admin_enqueue_scripts’, ‘wp_auth_check_load’ );

This is disabled for certain screens where a login screen could cause an inconvenient interruption. A filter called ‘wp_auth_check_load’ can be used for fine-grained control.

Source

File: wp-includes/functions.php 

function wp_auth_check_load() {
	if ( ! is_admin() && ! is_user_logged_in() ) {
		return;
	}

	if ( defined( 'IFRAME_REQUEST' ) ) {
		return;
	}

	$screen = get_current_screen();
	$hidden = array( 'update', 'update-network', 'update-core', 'update-core-network', 'upgrade', 'upgrade-network', 'network' );
	$show   = ! in_array( $screen->id, $hidden, true );

	/**
	 * Filters whether to load the authentication check.
	 *
	 * Returning a falsey value from the filter will effectively short-circuit
	 * loading the authentication check.
	 *
	 * @since 3.6.0
	 *
	 * @param bool      $show   Whether to load the authentication check.
	 * @param WP_Screen $screen The current screen object.
	 */
	if ( apply_filters( 'wp_auth_check_load', $show, $screen ) ) {
		wp_enqueue_style( 'wp-auth-check' );
		wp_enqueue_script( 'wp-auth-check' );

		add_action( 'admin_print_footer_scripts', 'wp_auth_check_html', 5 );
		add_action( 'wp_print_footer_scripts', 'wp_auth_check_html', 5 );
	}
}

Uses

Uses Description
wp-admin/includes/screen.php: get_current_screen()

Get the current screen object
wp-includes/pluggable.php: is_user_logged_in()

Determines whether the current visitor is a logged in user.
wp-includes/load.php: is_admin()

Determines whether the current request is for an administrative interface page.
wp-includes/functions.wp-scripts.php: wp_enqueue_script()

Enqueue a script.
wp-includes/functions.php: wp_auth_check_load

Filters whether to load the authentication check.
wp-includes/functions.wp-styles.php: wp_enqueue_style()

Enqueue a CSS stylesheet.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.
wp-includes/plugin.php: add_action()

Hooks a function on to a specific action.

Changelog

Version Description
3.6.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_auth_check_load