Changeset 53178

Timestamp:

04/14/2022 06:22:37 AM (3 years ago)

Author:

audrasjb

Message:

Users: Update parameters passed to the new send_retrieve_password_email and retrieve_password_notification_email filters.

For consistency with some similar filters like send_password_change_email or send_email_change_email, and for more flexibility, pass $user_login and $user_data parameters directly to the new send_retrieve_password_email and retrieve_password_notification_email filters.

Follow-up to [52604], [52605], [52606], [52607].

Props SergeyBiryukov, costdev, peterwilsoncc.
Fixes #54690.

File:

• trunk/src/wp-includes/user.php (modified) (3 diffs)

trunk/src/wp-includes/user.php

@@ -3095 +3095 @@
      * @since 6.0.0
      *
-     * @param bool $send Whether to send the email.
-     */
-    if ( ! apply_filters( 'send_retrieve_password_email', true ) ) {
+     * @param bool    $send       Whether to send the email.
+     * @param string  $user_login The username for the user.
+     * @param WP_User $user_data  WP_User object.
+     */
+    if ( ! apply_filters( 'send_retrieve_password_email', true, $user_login, $user_data ) ) {
         return true;
     }
@@ -3191 +3193 @@
     );
 
-    $data = compact( 'key', 'user_login', 'user_data' );
-
     /**
      * Filters the contents of the reset password notification email sent to the user.
@@ -3206 +3206 @@
      *     @type string $headers The headers of the email.
      * }
-     * @param array $data {
-     *     Additional information for extenders.
-     *
-     *     @type string  $key        The activation key.
-     *     @type string  $user_login The username for the user.
-     *     @type WP_User $user_data  WP_User object.
-     * }
-     */
-    $notification_email = apply_filters( 'retrieve_password_notification_email', $defaults, $data );
+     * @type string  $key        The activation key.
+     * @type string  $user_login The username for the user.
+     * @type WP_User $user_data  WP_User object.
+     */
+    $notification_email = apply_filters( 'retrieve_password_notification_email', $defaults, $key, $user_login, $user_data );
 
     if ( $switched_locale ) {