From 6c972cbaff1df0bdeea9b8650d6cb1eac55930f4 Mon Sep 17 00:00:00 2001
From: John Blackbourn <johnbillion@git.wordpress.org>
Date: Mon, 14 Mar 2016 22:30:31 +0000
Subject: [PATCH] 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
---
src/wp-includes/pluggable.php | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/src/wp-includes/pluggable.php b/src/wp-includes/pluggable.php
index 8db1a518e8..b69942c866 100644
--- a/src/wp-includes/pluggable.php
+++ b/src/wp-includes/pluggable.php
@@ -501,6 +501,7 @@ if ( !function_exists('wp_authenticate') ) :
* Authenticate a user, confirming the login credentials are valid.
*
* @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 $password User's password.
@@ -518,10 +519,11 @@ function wp_authenticate($username, $password) {
* WP_Error or null otherwise.
*
* @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.
* WP_Error or null otherwise.
- * @param string $username User login.
+ * @param string $username Username or email address.
* @param string $password User password
*/
$user = apply_filters( 'authenticate', null, $username, $password );
@@ -539,8 +541,9 @@ function wp_authenticate($username, $password) {
* Fires after a user login has failed.
*
* @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 );
}