authenticate │ filter-hook │ WP 2.8.0

Filters whether a set of user login credentials are valid.

A WP_User object is returned if the credentials authenticate a user. WP_Error or null otherwise.

Usage

add_filter( 'authenticate', 'wp_kama_authenticate_filter', 10, 3 );

/**
 * Function for `authenticate` filter-hook.
 * 
 * @param null|WP_User|WP_Error $user     WP_User if the user is authenticated. WP_Error or null otherwise.
 * @param string                $username Username or email address.
 * @param string                $password User password.
 *
 * @return null|WP_User|WP_Error
 */
function wp_kama_authenticate_filter( $user, $username, $password ){

	// filter...
	return $user;
}

$user(null|WP_User|WP_Error)

WP_User if the user is authenticated. WP_Error or null otherwise.

$username(string)

Username or email address.

$password(string)

User password.

Changelog

Where the hook is called

$user = apply_filters( 'authenticate', null, $username, $password );

Where the hook is used in WordPress

add_filter( 'authenticate', 'wp_authenticate_username_password', 20, 3 );

add_filter( 'authenticate', 'wp_authenticate_email_password', 20, 3 );

add_filter( 'authenticate', 'wp_authenticate_application_password', 20, 3 );

add_filter( 'authenticate', 'wp_authenticate_spam_check', 99 );

add_filter( 'authenticate', 'wp_authenticate_cookie', 30, 3 );