Upstream
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Users: Add new hooks to filter retrieve password emails. 

This change introduces two new hooks to help developers to filter retrieve password emails:

- `send_retrieve_password_email` can be used to filter whether to send the retrieve password email;
- `retrieve_password_notification_email` can be used to filter the contents of the reset password notification email sent to the user.

This changesets also adds unit tests for these new filters.

Props connapptivity, costdev, audrasjb, johnbillion.
Fixes #54690.

Built from https://develop.svn.wordpress.org/trunk@52604


git-svn-id: http://core.svn.wordpress.org/trunk@52192 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
audrasjb 2022-01-19 12:17:01 +00:00
parent 48aa21e9d9
commit e87e3dcf58
2 changed files with 62 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
wp-includes/user.php
View File

@ -2938,6 +2938,17 @@ function retrieve_password( $user_login = null ) {
return $errors;
}
/**
* Filter whether to send the retrieve password email.
*
* @since 6.0.0
*
* @param bool $send False to prevent sending. Default: true
*/
if ( ! apply_filters( 'send_retrieve_password_email', true ) ) {
return true;
}
// Redefining user_login ensures we return the right case in the email.
$user_login = $user_data->user_login;
$user_email = $user_data->user_email;
@ -3012,11 +3023,60 @@ function retrieve_password( $user_login = null ) {
*/
$message = apply_filters( 'retrieve_password_message', $message, $key, $user_login, $user_data );
// Short-circuit on falsey $message value for backwards compatibility.
if ( ! $message ) {
return true;
}
// Wrap the single notification email arguments in an array to pass them to the retrieve_password_notification_email filter.
$defaults = array(
'to' => $user_email,
'subject' => $title,
'message' => $message,
'headers' => '',
);
$data = compact( 'key', 'user_login', 'user_data' );
/**
* Filter the contents of the reset password notification email sent to the user.
*
* @since 6.0.0
*
* @param array $defaults {
* The default notification email arguments. Used to build wp_mail().
*
* @type string $to The intended recipient - user email address.
* @type string $subject The subject of the email.
* @type string $message The body of the email.
* @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 );
if ( $switched_locale ) {
restore_previous_locale();
}
if ( $message && ! wp_mail( $user_email, wp_specialchars_decode( $title ), $message ) ) {
if ( is_array( $notification_email ) ) {
// Force key order and merge defaults in case any value is missing in the filtered array.
$notification_email = array_merge( $defaults, $notification_email );
} else {
$notification_email = $defaults;
}
list( $to, $subject, $message, $headers ) = array_values( $notification_email );
$subject = wp_specialchars_decode( $subject );
if ( ! wp_mail( $to, $subject, $message, $headers ) ) {
$errors->add(
'retrieve_password_email_failure',
sprintf(

2
wp-includes/version.php
View File

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