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

Timestamp:

02/11/2020 09:41:26 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Privacy: Introduce filters for the headers of all the privacy-related e-mails:

• wp_privacy_personal_data_email_headers
• user_request_confirmed_email_headers
• user_erasure_complete_email_headers
• user_request_action_email_headers

Props xkon, garrett-eclipse, zaffarn, desrosj.
Fixes #44501.

File:

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

trunk/src/wp-includes/user.php

@@ -3295 +3295 @@
     $subject = apply_filters( 'user_request_confirmed_email_subject', $subject, $email_data['sitename'], $email_data );
 
-    $email_sent = wp_mail( $email_data['admin_email'], $subject, $content );
+    $headers = '';
+
+    /**
+     * Filters the headers of the user request confirmation email.
+     *
+     * @since 5.4.0
+     *
+     * @param string|array $headers    The email headers.
+     * @param string       $subject    The email subject.
+     * @param string       $content    The email content.
+     * @param int          $request_id The request ID.
+     * @param array        $email_data {
+     *     Data relating to the account action email.
+     *
+     *     @type WP_User_Request $request     User request object.
+     *     @type string          $user_email  The email address confirming a request
+     *     @type string          $description Description of the action being performed so the user knows what the email is for.
+     *     @type string          $manage_url  The link to click manage privacy requests of this type.
+     *     @type string          $sitename    The site name sending the mail.
+     *     @type string          $siteurl     The site URL sending the mail.
+     *     @type string          $admin_email The administrator email receiving the mail.
+     * }
+     */
+    $headers = apply_filters( 'user_request_confirmed_email_headers', $headers, $subject, $content, $request_id, $email_data );
+
+    $email_sent = wp_mail( $email_data['admin_email'], $subject, $content, $headers );
 
     if ( $email_sent ) {
@@ -3441 +3466 @@
     $content = str_replace( '###SITEURL###', esc_url_raw( $email_data['siteurl'] ), $content );
 
-    $email_sent = wp_mail( $user_email, $subject, $content );
+    $headers = '';
+
+    /**
+     * Filters the headers of the data erasure fulfillment notification.
+     *
+     * @since 5.4.0
+     *
+     * @param string|array $headers    The email headers.
+     * @param string       $subject    The email subject.
+     * @param string       $content    The email content.
+     * @param int          $request_id The request ID.
+     * @param array        $email_data {
+     *     Data relating to the account action email.
+     *
+     *     @type WP_User_Request $request            User request object.
+     *     @type string          $message_recipient  The address that the email will be sent to. Defaults
+     *                                               to the value of `$request->email`, but can be changed
+     *                                               by the `user_erasure_fulfillment_email_to` filter.
+     *     @type string          $privacy_policy_url Privacy policy URL.
+     *     @type string          $sitename           The site name sending the mail.
+     *     @type string          $siteurl            The site URL sending the mail.
+     * }
+     */
+    $headers = apply_filters( 'user_erasure_complete_email_headers', $headers, $subject, $content, $request_id, $email_data );
+
+    $email_sent = wp_mail( $user_email, $subject, $content, $headers );
 
     if ( $switched_locale ) {
@@ -3703 +3753 @@
     $subject = apply_filters( 'user_request_action_email_subject', $subject, $email_data['sitename'], $email_data );
 
-    $email_sent = wp_mail( $email_data['email'], $subject, $content );
+    $headers = '';
+
+    /**
+     * Filters the headers of the email sent when an account action is attempted.
+     *
+     * @since 5.4.0
+     *
+     * @param string|array $headers    The email headers.
+     * @param string       $subject    The email subject.
+     * @param string       $content    The email content.
+     * @param int          $request_id The request ID.
+     * @param array        $email_data {
+     *     Data relating to the account action email.
+     *
+     *     @type WP_User_Request $request     User request object.
+     *     @type string          $email       The email address this is being sent to.
+     *     @type string          $description Description of the action being performed so the user knows what the email is for.
+     *     @type string          $confirm_url The link to click on to confirm the account action.
+     *     @type string          $sitename    The site name sending the mail.
+     *     @type string          $siteurl     The site URL sending the mail.
+     * }
+     */
+    $headers = apply_filters( 'user_request_action_email_headers', $headers, $subject, $content, $request_id, $email_data );
+
+    $email_sent = wp_mail( $email_data['email'], $subject, $content, $headers );
 
     if ( $switched_locale ) {