Changeset 48084

Timestamp:

06/18/2020 08:22:16 PM (6 years ago)

Author:

SergeyBiryukov

Message:

Login and Registration: Introduce lostpassword_errors filter in retrieve_password() for errors encountered on a password reset request.

This complements the registration_errors filter in register_new_user().

Props wpdo5ea, dilipbheda.
Fixes #49521.

Location:

trunk/src

Files:

• wp-includes/user.php (modified) (1 diff)
• wp-login.php (modified) (1 diff)

trunk/src/wp-includes/user.php

@@ -2554 +2554 @@
          *
          * The filtered WP_Error object may, for example, contain errors for an invalid
-         * or existing username or email address. A WP_Error object should always returned,
+         * or existing username or email address. A WP_Error object should always be returned,
          * but may or may not contain errors.
          *

trunk/src/wp-login.php

@@ -382 +382 @@
          */
         do_action( 'lostpassword_post', $errors, $user_data );
+
+        /**
+         * Filters the errors encountered on a password reset request.
+         *
+         * The filtered WP_Error object may, for example, contain errors for an invalid
+         * username or email address. A WP_Error object should always be returned,
+         * but may or may not contain errors.
+         *
+         * If any errors are present in $errors, this will abort the password reset request.
+         *
+         * @since 5.5.0
+         *
+         * @param WP_Error $errors A WP_Error object containing any errors generated
+         *                         by using invalid credentials.
+         * @param WP_User|false    WP_User object if found, false if the user does not exist.
+         */
+        $errors = apply_filters( 'lostpassword_errors', $errors, $user_data );
 
         if ( $errors->has_errors() ) {