Docs: Further update the send_retrieve_password_email filter documentation for consistency.

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

See #54690.
Built from https://develop.svn.wordpress.org/trunk@52606


git-svn-id: http://core.svn.wordpress.org/trunk@52194 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2022-01-19 13:18:00 +00:00
parent 0dcc9fd03a
commit 3bc7449859
2 changed files with 6 additions and 4 deletions

View File

@ -2941,9 +2941,11 @@ function retrieve_password( $user_login = null ) {
/** /**
* Filters whether to send the retrieve password email. * Filters whether to send the retrieve password email.
* *
* Return false to disable sending the email.
*
* @since 6.0.0 * @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 ) ) { if ( ! apply_filters( 'send_retrieve_password_email', true ) ) {
return true; return true;
@ -3043,7 +3045,7 @@ function retrieve_password( $user_login = null ) {
* *
* @since 6.0.0 * @since 6.0.0
* *
* @param array $defaults { * @param array $notification_email {
* The default notification email arguments. Used to build wp_mail(). * The default notification email arguments. Used to build wp_mail().
* *
* @type string $to The intended recipient - user email address. * @type string $to The intended recipient - user email address.
@ -3059,7 +3061,7 @@ function retrieve_password( $user_login = null ) {
* @type WP_User $user_data WP_User object. * @type WP_User $user_data WP_User object.
* } * }
*/ */
$notification_email = apply_filters( 'retrieve_password_notification_email', $defaults, $data ); $notification_email = apply_filters( 'retrieve_password_notification_email', $notification_email, $data );
if ( $switched_locale ) { if ( $switched_locale ) {
restore_previous_locale(); restore_previous_locale();

View File

@ -16,7 +16,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '6.0-alpha-52605'; $wp_version = '6.0-alpha-52606';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.