apply_filters( ‘wp_authenticate_user’, WP_User|WP_Error $user, string $password )

User Contributed Notes

1. Skip to note 3 content

   Sanjeev Aryal 5 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

   Example Code:

   /**
    * Check User Status.
    *
    * @param $user WP_User Object
    */
   function check_status( WP_User $user ) {
   
   	$status = get_user_meta( $user->ID, 'user_status' );
   
   	if ( 1 !== (int) $status ) {
   		$message = esc_html__( 'User not verified.', 'text-domain');
   		return new WP_Error( 'user_not_verified', $message );
      }
   
       return $user;
   }
   
   add_filter( 'wp_authenticate_user', 'check_status' );

   • Replace:

     $status = get_user_meta( $user->ID, 'user_status' );

     With:

     $status = get_user_meta( $user->ID, 'user_status', true );

     It will save many headaches.

     peps23 5 years ago
2. Skip to note 4 content

   Collins Mbaka 4 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

   A basic usage example

   add_filter('wp_authenticate_user', 'myplugin_auth_login',10,2);
   
   function myplugin_auth_login ($user, $password) {
        //do any extra validation stuff here
        return $user;
   }

   This hook passes two parameters, $user and $password (plaintext). In order to generate an error on login, you will need to return a new WP_Error() object.