Filter hook 'wp_authenticate_user'

Hook Information

Hook Parameters

Usage Examples

<?php
// Hook into wp_authenticate_user
add_filter('wp_authenticate_user', 'my_custom_filter', 10, 3);

function my_custom_filter($user, $email, $password) {
    // Your custom filtering logic here
    return $user;
}

Source Code Context

<?php
 280  			__( 'Unknown email address. Check again or try your username.' )
 281  		);
 282  	}
 283  
 284  	/** This filter is documented in wp-includes/user.php */
 285  	$user = apply_filters( 'wp_authenticate_user', $user, $password );
 286  
 287  	if ( is_wp_error( $user ) ) {
 288  		return $user;
 289  	}
 290  

PHP Documentation

<?php
/**
 * Authenticates a user using the email and password.
 *
 * @since 4.5.0
 *
 * @param WP_User|WP_Error|null $user     WP_User or WP_Error object if a previous
 *                                        callback failed authentication.
 * @param string                $email    Email address for authentication.
 * @param string                $password Password for authentication.
 * @return WP_User|WP_Error WP_User on success, WP_Error on failure.
 */