Changeset 52606 for trunk/src/wp-includes/user.php

Timestamp:

01/19/2022 01:16:44 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Further update the send_retrieve_password_email filter documentation for consistency.

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

See #54690.

File:

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

trunk/src/wp-includes/user.php

@@ -2942 +2942 @@
      * Filters whether to send the retrieve password email.
      *
+     * Return false to disable sending the email.
+     *
      * @since 6.0.0
      *
-     * @param bool $send False to prevent sending. Default true.
+     * @param bool $send Whether to send the email.
      */
     if ( ! apply_filters( 'send_retrieve_password_email', true ) ) {
@@ -3044 +3046 @@
      * @since 6.0.0
      *
-     * @param array $defaults {
+     * @param array $notification_email {
      *     The default notification email arguments. Used to build wp_mail().
      *
@@ -3060 +3062 @@
      * }
      */
-    $notification_email = apply_filters( 'retrieve_password_notification_email', $defaults, $data );
+    $notification_email = apply_filters( 'retrieve_password_notification_email', $notification_email, $data );
 
     if ( $switched_locale ) {