Summery Summery
Filters whether a set of user login credentials are valid.
Syntax Syntax
Description Description
A WP_User object is returned if the credentials authenticate a user. WP_Error or null otherwise.
Parameters Parameters
- $user
-
WP_User if the user is authenticated. WP_Error or null otherwise.
- $username
-
Username or email address.
- $password
-
User password
Source Source
Advertisement
Changelog Changelog
Version | Description |
---|---|
4.5.0 | $username now accepts an email address. |
2.8.0 | Introduced. |