wp_authenticate_user │ filter-hook │ WP 2.5.0

Filters whether the given user can be authenticated with the provided password.

Usage

add_filter( 'wp_authenticate_user', 'wp_kama_authenticate_user_filter', 10, 2 );

/**
 * Function for `wp_authenticate_user` filter-hook.
 * 
 * @param WP_User|WP_Error $user     WP_User or WP_Error object if a previous callback failed authentication.
 * @param string           $password Password to check against the user.
 *
 * @return WP_User|WP_Error
 */
function wp_kama_authenticate_user_filter( $user, $password ){

	// filter...
	return $user;
}

$user(WP_User|WP_Error)

WP_User or WP_Error object if a previous callback failed authentication.

$password(string)

Password to check against the user.

Changelog

Where the hook is called

$user = apply_filters( 'wp_authenticate_user', $user, $password );

$user = apply_filters( 'wp_authenticate_user', $user, $password );

Where the hook is used in WordPress