diff --git a/src/wp-admin/includes/privacy-tools.php b/src/wp-admin/includes/privacy-tools.php index efe46cce32..da05163a33 100644 --- a/src/wp-admin/includes/privacy-tools.php +++ b/src/wp-admin/includes/privacy-tools.php @@ -595,7 +595,34 @@ All at ###SITENAME### $content = str_replace( '###SITENAME###', $site_name, $content ); $content = str_replace( '###SITEURL###', esc_url_raw( $site_url ), $content ); - $mail_success = wp_mail( $request_email, $subject, $content ); + $headers = ''; + + /** + * Filters the headers of the email sent with a personal data export file. + * + * @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 int $expiration The time in seconds until the export file expires. + * @type string $expiration_date The localized date and time when the export file expires. + * @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 `wp_privacy_personal_data_email_to` filter. + * @type string $export_file_url The export file URL. + * @type string $sitename The site name sending the mail. + * @type string $siteurl The site URL sending the mail. + * } + */ + $headers = apply_filters( 'wp_privacy_personal_data_email_headers', $headers, $subject, $content, $request_id, $email_data ); + + $mail_success = wp_mail( $request_email, $subject, $content, $headers ); if ( $switched_locale ) { restore_previous_locale(); diff --git a/src/wp-includes/user.php b/src/wp-includes/user.php index a1478679f6..f5c611ebec 100644 --- a/src/wp-includes/user.php +++ b/src/wp-includes/user.php @@ -3178,7 +3178,31 @@ All at ###SITENAME### */ $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 $email_text 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_confirmed_email_headers', $headers, $subject, $content, $request_id, $email_data ); + + $email_sent = wp_mail( $email_data['admin_email'], $subject, $content, $headers ); if ( $email_sent ) { update_post_meta( $request_id, '_wp_admin_notified', true ); @@ -3324,7 +3348,31 @@ All at ###SITENAME### $content = str_replace( '###PRIVACY_POLICY_URL###', $email_data['privacy_policy_url'], $content ); $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 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 $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_erasure_complete_email_headers', $headers, $subject, $content, $request_id, $email_data ); + + $email_sent = wp_mail( $user_email, $subject, $content, $headers ); if ( $switched_locale ) { restore_previous_locale(); @@ -3586,7 +3634,31 @@ All at ###SITENAME### */ $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 $email_text 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 ) { restore_previous_locale(); diff --git a/tests/phpunit/tests/privacy/wpPrivacySendErasureFulfillmentNotification.php b/tests/phpunit/tests/privacy/wpPrivacySendErasureFulfillmentNotification.php index 01c90ae3bc..5a2b1c62a4 100644 --- a/tests/phpunit/tests/privacy/wpPrivacySendErasureFulfillmentNotification.php +++ b/tests/phpunit/tests/privacy/wpPrivacySendErasureFulfillmentNotification.php @@ -256,6 +256,38 @@ class Tests_Privacy_WpPrivacySendErasureFulfillmentNotification extends WP_UnitT return 'Modified text'; } + /** + * The email headers of the fulfillment notification should be filterable. + * + * @since 5.4.0 + * + * @ticket 44501 + */ + public function test_email_headers_should_be_filterable() { + add_filter( 'user_erasure_complete_email_headers', array( $this, 'modify_email_headers' ) ); + _wp_privacy_send_erasure_fulfillment_notification( self::$request_id ); + + $mailer = tests_retrieve_phpmailer_instance(); + + $this->assertContains( 'From: Tester ', $mailer->get_sent()->header ); + } + + /** + * Filter callback that modifies the email headers of the data erasure fulfillment notification. + * + * @since 5.4.0 + * + * @param string|array $headers The email headers. + * @return array $headers The new email headers. + */ + public function modify_email_headers( $headers ) { + $headers = array( + 'From: Tester ', + ); + + return $headers; + } + /** * The function should not send an email when the request ID does not exist. * diff --git a/tests/phpunit/tests/privacy/wpPrivacySendPersonalDataExportEmail.php b/tests/phpunit/tests/privacy/wpPrivacySendPersonalDataExportEmail.php index 13ee61a59d..f5fa6b4145 100644 --- a/tests/phpunit/tests/privacy/wpPrivacySendPersonalDataExportEmail.php +++ b/tests/phpunit/tests/privacy/wpPrivacySendPersonalDataExportEmail.php @@ -252,6 +252,38 @@ class Tests_Privacy_WpPrivacySendPersonalDataExportEmail extends WP_UnitTestCase return 'Custom content for request ID: ' . $request_id; } + /** + * The email headers should be filterable. + * + * @since 5.4.0 + * + * @ticket 44501 + */ + public function test_email_headers_should_be_filterable() { + add_filter( 'wp_privacy_personal_data_email_headers', array( $this, 'modify_email_headers' ) ); + wp_privacy_send_personal_data_export_email( self::$request_id ); + + $mailer = tests_retrieve_phpmailer_instance(); + + $this->assertContains( 'From: Tester ', $mailer->get_sent()->header ); + } + + /** + * Filter callback to modify the headers of the email sent with a personal data export file. + * + * @since 5.4.0 + * + * @param string|array $headers The email headers. + * @return array $headers The new email headers. + */ + public function modify_email_headers( $headers ) { + $headers = array( + 'From: Tester ', + ); + + return $headers; + } + /** * The email content should be filterable using the $email_data * diff --git a/tests/phpunit/tests/privacy/wpPrivacySendRequestConfirmationNotification.php b/tests/phpunit/tests/privacy/wpPrivacySendRequestConfirmationNotification.php index 09aa8305a5..6f50c2226d 100644 --- a/tests/phpunit/tests/privacy/wpPrivacySendRequestConfirmationNotification.php +++ b/tests/phpunit/tests/privacy/wpPrivacySendRequestConfirmationNotification.php @@ -207,4 +207,42 @@ class Tests_User_WpPrivacySendRequestConfirmationNotification extends WP_UnitTes return $email_text; } + /** + * The email headers should be filterable. + * + * @since 5.4.0 + * + * @ticket 44501 + */ + public function test_email_headers_should_be_filterable() { + $email = 'export.request.from.unregistered.user@example.com'; + $request_id = wp_create_user_request( $email, 'export_personal_data' ); + + _wp_privacy_account_request_confirmed( $request_id ); + + add_filter( 'user_request_confirmed_email_headers', array( $this, 'modify_email_headers' ) ); + _wp_privacy_send_request_confirmation_notification( $request_id ); + remove_filter( 'user_request_confirmed_email_headers', array( $this, 'modify_email_headers' ) ); + + $mailer = tests_retrieve_phpmailer_instance(); + + $this->assertContains( 'From: Tester ', $mailer->get_sent()->header ); + } + + /** + * Filter callback that modifies the headers of the user request confirmation email. + * + * @since 5.4.0 + * + * @param string|array $headers The email headers. + * @return array $headers The new email headers. + */ + public function modify_email_headers( $headers ) { + $headers = array( + 'From: Tester ', + ); + + return $headers; + } + } diff --git a/tests/phpunit/tests/user/wpSendUserRequest.php b/tests/phpunit/tests/user/wpSendUserRequest.php index 2ccbe19e28..3f240545fc 100644 --- a/tests/phpunit/tests/user/wpSendUserRequest.php +++ b/tests/phpunit/tests/user/wpSendUserRequest.php @@ -228,6 +228,40 @@ class Tests_User_WpSendUserRequest extends WP_UnitTestCase { return 'Custom Email Content.'; } + /** + * The email headers should be filterable. + * + * @since 5.4.0 + * + * @ticket 44501 + */ + public function test_email_headers_should_be_filterable() { + $request_id = wp_create_user_request( self::$test_user->user_email, 'remove_personal_data' ); + + add_filter( 'user_request_action_email_headers', array( $this, 'modify_email_headers' ) ); + $result = wp_send_user_request( $request_id ); + + $mailer = tests_retrieve_phpmailer_instance(); + + $this->assertContains( 'From: Tester ', $mailer->get_sent()->header ); + } + + /** + * Filter callback to modify the headers of the email sent when an account action is attempted. + * + * @since 5.4.0 + * + * @param string|array $headers The email headers. + * @return array $headers The new email headers. + */ + public function modify_email_headers( $headers ) { + $headers = array( + 'From: Tester ', + ); + + return $headers; + } + /** * The function should error when the email was not sent. *