Users: Add `@since` entries to `wp_authenticate()` and its filters now that the `$username` parameter can also be an email address.

See #9568, #35986


git-svn-id: https://develop.svn.wordpress.org/trunk@36992 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn 2016-03-14 22:30:31 +00:00
parent 30d63dde4b
commit 6c972cbaff
1 changed files with 5 additions and 2 deletions

View File

@ -501,6 +501,7 @@ if ( !function_exists('wp_authenticate') ) :
* Authenticate a user, confirming the login credentials are valid. * Authenticate a user, confirming the login credentials are valid.
* *
* @since 2.5.0 * @since 2.5.0
* @since 4.5.0 $username can also be an email address.
* *
* @param string $username User's username or email address. * @param string $username User's username or email address.
* @param string $password User's password. * @param string $password User's password.
@ -518,10 +519,11 @@ function wp_authenticate($username, $password) {
* WP_Error or null otherwise. * WP_Error or null otherwise.
* *
* @since 2.8.0 * @since 2.8.0
* @since 4.5.0 $username can also be an email address.
* *
* @param null|WP_User|WP_Error $user WP_User if the user is authenticated. * @param null|WP_User|WP_Error $user WP_User if the user is authenticated.
* WP_Error or null otherwise. * WP_Error or null otherwise.
* @param string $username User login. * @param string $username Username or email address.
* @param string $password User password * @param string $password User password
*/ */
$user = apply_filters( 'authenticate', null, $username, $password ); $user = apply_filters( 'authenticate', null, $username, $password );
@ -539,8 +541,9 @@ function wp_authenticate($username, $password) {
* Fires after a user login has failed. * Fires after a user login has failed.
* *
* @since 2.5.0 * @since 2.5.0
* @since 4.5.0 $username can also be an email address.
* *
* @param string $username User login. * @param string $username Username or email address.
*/ */
do_action( 'wp_login_failed', $username ); do_action( 'wp_login_failed', $username );
} }