<!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>[45825] trunk: Privacy: Add descriptions for sections in a personal data export file.</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/45825">45825</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/45825","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-08-18 02:07:00 +0000 (Sun, 18 Aug 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: Add descriptions for sections in a personal data export file.
Props garrett-eclipse, Venutius, karmatosed.
Fixes <a href="https://core.trac.wordpress.org/ticket/45491">#45491</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesprivacytoolsphp">trunk/src/wp-admin/includes/privacy-tools.php</a></li>
<li><a href="#trunksrcwpincludescommentphp">trunk/src/wp-includes/comment.php</a></li>
<li><a href="#trunksrcwpincludesmediaphp">trunk/src/wp-includes/media.php</a></li>
<li><a href="#trunksrcwpincludesuserphp">trunk/src/wp-includes/user.php</a></li>
<li><a href="#trunktestsphpunittestsprivacywpPrivacyProcessPersonalDataExportPagephp">trunk/tests/phpunit/tests/privacy/wpPrivacyProcessPersonalDataExportPage.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-08-17 14:33:01 UTC (rev 45824)
+++ trunk/src/wp-admin/includes/privacy-tools.php 2019-08-18 02:07:00 UTC (rev 45825)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -234,7 +234,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string The HTML for this group and its items.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_privacy_generate_personal_data_export_group_html( $group_data ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $group_html = '<h2>' . esc_html( $group_data['group_label'] ) . '</h2>';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $group_html = '<h2>' . esc_html( $group_data['group_label'] ) . '</h2>';
+
+ if ( ! empty( $group_data['group_description'] ) ) {
+ $group_html .= '<p>' . esc_html( $group_data['group_description'] ) . '</p>';
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $group_html .= '<div>';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( (array) $group_data['items'] as $group_item_id => $group_item_data ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -355,8 +360,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // First, build an "About" group on the fly for this report.
</span><span class="cx" style="display: block; padding: 0 10px"> $about_group = array(
</span><span class="cx" style="display: block; padding: 0 10px"> /* translators: Header for the About section in a personal data export. */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'group_label' => _x( 'About', 'personal data group label' ),
- 'items' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'group_label' => _x( 'About', 'personal data group label' ),
+ /* translators: Description for the About section in a personal data export. */
+ 'group_description' => _x( 'Overview of export report.', 'personal data group description' ),
+ 'items' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'about-1' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'name' => _x( 'Report generated for', 'email address' ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -613,10 +620,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( (array) $export_data as $export_datum ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $group_id = $export_datum['group_id'];
</span><span class="cx" style="display: block; padding: 0 10px"> $group_label = $export_datum['group_label'];
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $group_description = '';
+ if ( ! empty( $export_datum['group_description'] ) ) {
+ $group_description = $export_datum['group_description'];
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! array_key_exists( $group_id, $groups ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $groups[ $group_id ] = array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'group_label' => $group_label,
- 'items' => array(),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'group_label' => $group_label,
+ 'group_description' => $group_description,
+ 'items' => array(),
</ins><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></span></pre></div>
<a id="trunksrcwpincludescommentphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/comment.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/comment.php 2019-08-17 14:33:01 UTC (rev 45824)
+++ trunk/src/wp-includes/comment.php 2019-08-18 02:07:00 UTC (rev 45825)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3434,10 +3434,11 @@
</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"> $data_to_export[] = array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'group_id' => 'comments',
- 'group_label' => __( 'Comments' ),
- 'item_id' => "comment-{$comment->comment_ID}",
- 'data' => $comment_data_to_export,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'group_id' => 'comments',
+ 'group_label' => __( 'Comments' ),
+ 'group_description' => __( 'User’s comment data.' ),
+ 'item_id' => "comment-{$comment->comment_ID}",
+ 'data' => $comment_data_to_export,
</ins><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></span></pre></div>
<a id="trunksrcwpincludesmediaphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/media.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/media.php 2019-08-17 14:33:01 UTC (rev 45824)
+++ trunk/src/wp-includes/media.php 2019-08-18 02:07:00 UTC (rev 45825)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4307,10 +4307,11 @@
</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"> $data_to_export[] = array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'group_id' => 'media',
- 'group_label' => __( 'Media' ),
- 'item_id' => "post-{$post->ID}",
- 'data' => $post_data_to_export,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'group_id' => 'media',
+ 'group_label' => __( 'Media' ),
+ 'group_description' => __( 'User’s media data.' ),
+ 'item_id' => "post-{$post->ID}",
+ 'data' => $post_data_to_export,
</ins><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></span></pre></div>
<a id="trunksrcwpincludesuserphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/user.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/user.php 2019-08-17 14:33:01 UTC (rev 45824)
+++ trunk/src/wp-includes/user.php 2019-08-18 02:07:00 UTC (rev 45825)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2994,10 +2994,11 @@
</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"> $data_to_export[] = array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'group_id' => 'user',
- 'group_label' => __( 'User' ),
- 'item_id' => "user-{$user->ID}",
- 'data' => $user_data_to_export,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'group_id' => 'user',
+ 'group_label' => __( 'User' ),
+ 'group_description' => __( 'User’s profile data.' ),
+ 'item_id' => "user-{$user->ID}",
+ 'data' => $user_data_to_export,
</ins><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"> return array(
</span></span></pre></div>
<a id="trunktestsphpunittestsprivacywpPrivacyProcessPersonalDataExportPagephp"></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/wpPrivacyProcessPersonalDataExportPage.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/privacy/wpPrivacyProcessPersonalDataExportPage.php 2019-08-17 14:33:01 UTC (rev 45824)
+++ trunk/tests/phpunit/tests/privacy/wpPrivacyProcessPersonalDataExportPage.php 2019-08-18 02:07:00 UTC (rev 45825)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -142,10 +142,11 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $data = array(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'group_id' => 'custom-exporter-group-id',
- 'group_label' => 'custom-exporter-group-label',
- 'item_id' => 'custom-exporter-item-id',
- 'data' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'group_id' => 'custom-exporter-group-id',
+ 'group_label' => 'Custom Exporter Group Label',
+ 'group_description' => 'Custom Exporter Group Description',
+ 'item_id' => 'custom-exporter-item-id',
+ 'data' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'name' => 'Email',
</span><span class="cx" style="display: block; padding: 0 10px"> 'value' => self::$requester_email,
</span></span></pre>
</div>
</div>
</body>
</html>