Description
Filters whether a set of user login credentials are valid. A WP_User object is returned if the credentials authenticate a user. WP_Error or null otherwise.
Occurrences
| Filename | Line Number |
|---|---|
| wp-includes/pluggable.php | 618 |
Parameters
| Type | Name | Description |
|---|---|---|
| null|WP_User|WP_Error | $user | WP_User if the user is authenticated. WP_Error or null otherwise. |
| string | $username | Username or email address. |
| string | $password | User password. |
PHP Doc
/**
* Filters whether a set of user login credentials are valid.
*
* A WP_User object is returned if the credentials authenticate a user.
* WP_Error or null otherwise.
*
* @since 2.8.0
* @since 4.5.0 `$username` now accepts an email address.
*
* @param null|WP_User|WP_Error $user WP_User if the user is authenticated.
* WP_Error or null otherwise.
* @param string $username Username or email address.
* @param string $password User password.
*/