<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[46265] trunk: Privacy: Introduce `wp_privacy_personal_data_email_to` and `wp_privacy_personal_data_email_subject` filters.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/46265">46265</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/46265","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-09-23 19:24:20 +0000 (Mon, 23 Sep 2019)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Privacy: Introduce `wp_privacy_personal_data_email_to` and `wp_privacy_personal_data_email_subject` filters.
Pass email data to the `wp_privacy_personal_data_email_content` filter.
Props garrett-eclipse, thakkarhardik, birgire.
Fixes <a href="https://core.trac.wordpress.org/ticket/46303">#46303</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesprivacytoolsphp">trunk/src/wp-admin/includes/privacy-tools.php</a></li>
<li><a href="#trunktestsphpunittestsprivacywpPrivacySendPersonalDataExportEmailphp">trunk/tests/phpunit/tests/privacy/wpPrivacySendPersonalDataExportEmail.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesprivacytoolsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/privacy-tools.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/privacy-tools.php 2019-09-23 19:12:04 UTC (rev 46264)
+++ trunk/src/wp-admin/includes/privacy-tools.php 2019-09-23 19:24:20 UTC (rev 46265)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -493,6 +493,57 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $expiration = apply_filters( 'wp_privacy_export_expiration', 3 * DAY_IN_SECONDS );
</span><span class="cx" style="display: block; padding: 0 10px"> $expiration_date = date_i18n( get_option( 'date_format' ), time() + $expiration );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $export_file_url = get_post_meta( $request_id, '_export_file_url', true );
+ $site_name = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
+ $site_url = home_url();
+
+ /**
+ * Filters the recipient of the personal data export email notification.
+ * Should be used with great caution to avoid sending the data export link to wrong emails.
+ *
+ * @since 5.3.0
+ *
+ * @param string $request_email The email address of the notification recipient.
+ * @param WP_User_Request $request The request that is initiating the notification.
+ */
+ $request_email = apply_filters( 'wp_privacy_personal_data_email_to', $request->email, $request );
+
+ $email_data = array(
+ 'request' => $request,
+ 'expiration' => $expiration,
+ 'expiration_date' => $expiration_date,
+ 'message_recipient' => $request_email,
+ 'export_file_url' => $export_file_url,
+ 'sitename' => $site_name,
+ 'siteurl' => $site_url,
+ );
+
+ /* translators: Personal data export notification email subject. %s: Site title. */
+ $subject = sprintf( __( '[%s] Personal Data Export' ), $site_name );
+
+ /**
+ * Filters the subject of the email sent when an export request is completed.
+ *
+ * @since 5.3.0
+ *
+ * @param string $subject The email subject.
+ * @param string $sitename The name of the site.
+ * @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.
+ * }
+ */
+ $subject = apply_filters( 'wp_privacy_personal_data_email_subject', $subject, $site_name, $email_data );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /* translators: Do not translate EXPIRATION, LINK, SITENAME, SITEURL: those are placeholders. */
</span><span class="cx" style="display: block; padding: 0 10px"> $email_text = __(
</span><span class="cx" style="display: block; padding: 0 10px"> 'Howdy,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -519,32 +570,32 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * ###SITEURL### The URL to the site.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.9.6
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.3.0 Introduced the `$email_data` array.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $email_text Text in the email.
- * @param int $request_id The request ID for this personal data export.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $email_text Text in the email.
+ * @param int $request_id The request ID for this personal data export.
+ * @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.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $content = apply_filters( 'wp_privacy_personal_data_email_content', $email_text, $request_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $content = apply_filters( 'wp_privacy_personal_data_email_content', $email_text, $request_id, $email_data );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $email_address = $request->email;
- $export_file_url = get_post_meta( $request_id, '_export_file_url', true );
- $site_name = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
- $site_url = home_url();
-
</del><span class="cx" style="display: block; padding: 0 10px"> $content = str_replace( '###EXPIRATION###', $expiration_date, $content );
</span><span class="cx" style="display: block; padding: 0 10px"> $content = str_replace( '###LINK###', esc_url_raw( $export_file_url ), $content );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $content = str_replace( '###EMAIL###', $email_address, $content );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $content = str_replace( '###EMAIL###', $request_email, $content );
</ins><span class="cx" style="display: block; padding: 0 10px"> $content = str_replace( '###SITENAME###', $site_name, $content );
</span><span class="cx" style="display: block; padding: 0 10px"> $content = str_replace( '###SITEURL###', esc_url_raw( $site_url ), $content );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $mail_success = wp_mail(
- $email_address,
- sprintf(
- /* translators: Personal data export notification email subject. %s: Site title. */
- __( '[%s] Personal Data Export' ),
- $site_name
- ),
- $content
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $mail_success = wp_mail( $request_email, $subject, $content );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $switched_locale ) {
</span><span class="cx" style="display: block; padding: 0 10px"> restore_previous_locale();
</span></span></pre></div>
<a id="trunktestsphpunittestsprivacywpPrivacySendPersonalDataExportEmailphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/privacy/wpPrivacySendPersonalDataExportEmail.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/privacy/wpPrivacySendPersonalDataExportEmail.php 2019-09-23 19:12:04 UTC (rev 46264)
+++ trunk/tests/phpunit/tests/privacy/wpPrivacySendPersonalDataExportEmail.php 2019-09-23 19:24:20 UTC (rev 46265)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -175,6 +175,58 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The email address of the recipient of the personal data export notification should be filterable.
+ *
+ * @ticket 46303
+ */
+ public function test_email_address_of_recipient_should_be_filterable() {
+ add_filter( 'wp_privacy_personal_data_email_to', array( $this, 'filter_email_address' ) );
+ wp_privacy_send_personal_data_export_email( self::$request_id );
+
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ $this->assertSame( 'modified-' . self::$requester_email, $mailer->get_recipient( 'to' )->address );
+ }
+
+ /**
+ * Filter callback that modifies the email address of the recipient of the personal data export notification.
+ *
+ * @since 5.3.0
+ *
+ * @param string $user_email The email address of the notification recipient.
+ * @return string $user_email The modified email address of the notification recipient.
+ */
+ public function filter_email_address( $user_email ) {
+ return 'modified-' . $user_email;
+ }
+
+ /**
+ * The email subject of the personal data export notification should be filterable.
+ *
+ * @ticket 46303
+ */
+ public function test_email_subject_should_be_filterable() {
+ add_filter( 'wp_privacy_personal_data_email_subject', array( $this, 'filter_email_subject' ) );
+ wp_privacy_send_personal_data_export_email( self::$request_id );
+
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ $this->assertSame( 'Modified subject', $mailer->get_sent()->subject );
+ }
+
+ /**
+ * Filter callback that modifies the email subject of the data erasure fulfillment notification.
+ *
+ * @since 5.3.0
+ *
+ * @param string $subject The email subject.
+ * @return string $subject The email subject.
+ */
+ public function filter_email_subject( $subject ) {
+ return 'Modified subject';
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * The email content should be filterable.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.9.6
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -201,6 +253,47 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The email content should be filterable using the $email_data
+ *
+ * @ticket 46303
+ */
+ public function test_email_content_should_be_filterable_using_email_data() {
+ add_filter( 'wp_privacy_personal_data_email_content', array( $this, 'modify_email_content_with_email_data' ), 10, 3 );
+ wp_privacy_send_personal_data_export_email( self::$request_id );
+
+ $site_url = home_url();
+ $mailer = tests_retrieve_phpmailer_instance();
+ $this->assertContains( 'Custom content using the $site_url of $email_data: ' . $site_url, $mailer->get_sent()->body );
+ }
+
+ /**
+ * Filter callback that modifies the text of the email by using the $email_data sent with a personal data export file.
+ *
+ * @since 5.3.0
+ *
+ * @param string $email_text Text in the email.
+ * @param int $request_id The request ID for this personal data export.
+ * @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.
+ * }
+ *
+ * @return string $email_text Text in the email.
+ */
+ public function modify_email_content_with_email_data( $email_text, $request_id, $email_data ) {
+ return 'Custom content using the $site_url of $email_data: ' . $email_data['siteurl'];
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * The function should respect the user locale settings when the site uses the default locale.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.2.0
</span></span></pre>
</div>
</div>
</body>
</html>