apply_filters( 'authenticate', null|WP_User|WP_Error $user , string $username , string $password )
Filters whether a set of user login credentials are valid.
Description Description
A WP_User object is returned if the credentials authenticate a user. WP_Error or null otherwise.
Parameters Parameters
Source Source
Changelog Changelog
Version | Description |
---|---|
4.5.0 | $username now accepts an email address. |
2.8.0 | Introduced. |
User Contributed Notes User Contributed Notes
You must log in before being able to contribute a note or feedback.
==Examples==
The basic usage is as follows…
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.
… or simply return null.
WordPress will assign a standard WP_Error object: