apply_filters( ‘authenticate’, null|WP_User|WP_Error $user, string $username, string $password )

User Contributed Notes

1. Skip to note 4 content

   Rahul Prajapati 9 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

   ==Examples==
   The basic usage is as follows…

   add_filter( 'authenticate', 'myplugin_auth_signon', 30, 3 );
   function myplugin_auth_signon( $user, $username, $password ) {
        return $user;
   }

   This hook passes three parameters, $user, $username and $password. In order to generate an error on login, you will need to return a WP_Error object.
2. Skip to note 5 content

   Dragi Postolovski 4 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: -2You must log in to vote on the helpfulness of this note

   function wpdocs_authenticate_user( $user, $username, $password ) {
   	if ( empty( $username ) || empty( $password ) ) {
   		$error = new WP_Error();
   		$user  = new WP_Error( 'authentication_failed', __( 'ERROR: Invalid username or incorrect password.' ) );
   		return $error;
   	}
   
   	return $user;
   }
   add_filter( 'authenticate', 'wpdocs_authenticate_user', 10, 3 );

   Goes nicely with:

   public function wpdocs_login_form_failed( $username ) {
   	// append some information (login=failed) to the URL
   	wp_redirect( home_url() . '/?login=failed' );
   	exit;
   }
   
   add_action( 'wp_login_failed', 'wpdocs_login_form_failed' );
3. Skip to note 6 content

   pronl 8 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: -3You must log in to vote on the helpfulness of this note

   … or simply return null.

   WordPress will assign a standard WP_Error object:

   if ( $user == null ) {
   	// TODO what should the error message be? (Or would these even happen?)
   	// Only needed if all authentication handlers fail to return anything.
   	$user = new WP_Error( 'authentication_failed', __( '<strong>ERROR</strong>: Invalid username, email address or incorrect password.' ) );
   }