<!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>[43117] branches/4.9: Privacy: add user information to the 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/43117">43117</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/43117","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>2018-05-02 04:20:35 +0000 (Wed, 02 May 2018)</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 user information to the personal data export file.

Props TZ-Media, desrosj.
Merges <a href="https://core.trac.wordpress.org/changeset/43055">[43055]</a> and <a href="https://core.trac.wordpress.org/changeset/43116">[43116]</a> to the 4.9 branch.
See <a href="https://core.trac.wordpress.org/ticket/43547">#43547</a>.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#branches49srcwpincludesdefaultfiltersphp">branches/4.9/src/wp-includes/default-filters.php</a></li>
<li><a href="#branches49srcwpincludesuserphp">branches/4.9/src/wp-includes/user.php</a></li>
<li><a href="#branches49testsphpunittestsuserphp">branches/4.9/tests/phpunit/tests/user.php</a></li>
</ul>

<h3>Property Changed</h3>
<ul>
<li><a href="#branches49">branches/4.9/</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: branches/4.9
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- branches/4.9 2018-05-02 04:10:17 UTC (rev 43116)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ branches/4.9  2018-05-02 04:20:35 UTC (rev 43117)
</ins><a id="branches49"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: branches/4.9</h4>
<pre class="diff"><span>
</span></pre></div>
<a id="svnmergeinfo"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: svn:mergeinfo</h4></div>
<span class="cx" style="display: block; padding: 0 10px"> /branches/3.1:18031
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/3.3:20543
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/3.4:21757
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/trunk:18512,42132,42134,42136,42138,42140,42144,42146,42148,42150,42152-42153,42155,42157,42159,42161,42163,42169,42171,42173,42175,42177,42181,42183,42185,42187,42189,42191,42193,42199,42203,42210,42214,42220,42222,42226,42242,42244,42247,42251,42256-42261,42350,42358,42362,42364-42368,42374,42388,42390,42401,42417,42421,42423-42425,42430,42433,42437,42441,42443,42446-42447,42449,42451,42453,42457,42459,42462,42491,42521,42529,42531,42533,42536,42538,42541,42543,42545,42549,42566,42568,42570,42572,42574,42576,42579,42581-42582,42584-42585,42587-42588,42590,42592,42594-42595,42598-42599,42602,42604,42606,42611-42613,42615,42617,42624-42625,42639,42648,42652-42653,42665,42687,42711,42713,42719,42722,42739-42740,42744,42758,42791-42792,42801,42814,42817-42818,42823,42830,42837,42839,42841,42844,42851-42852,42860,42864,42881,42888-42889,42892-42894,42930,42964,42967,42971-42972,42977-42978
 ,42980,42985-42987,42989,42992,42994-42995,42998-42999,43001-43004,43007-43008,43011-43012,43014-43015,43025,43027,43030,43032,43034,43036,43039,43045-43047,43053-43054,43056-43063,43065,43081,43085,43088-43089,43091,43104
</del><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/trunk:18512,42132,42134,42136,42138,42140,42144,42146,42148,42150,42152-42153,42155,42157,42159,42161,42163,42169,42171,42173,42175,42177,42181,42183,42185,42187,42189,42191,42193,42199,42203,42210,42214,42220,42222,42226,42242,42244,42247,42251,42256-42261,42350,42358,42362,42364-42368,42374,42388,42390,42401,42417,42421,42423-42425,42430,42433,42437,42441,42443,42446-42447,42449,42451,42453,42457,42459,42462,42491,42521,42529,42531,42533,42536,42538,42541,42543,42545,42549,42566,42568,42570,42572,42574,42576,42579,42581-42582,42584-42585,42587-42588,42590,42592,42594-42595,42598-42599,42602,42604,42606,42611-42613,42615,42617,42624-42625,42639,42648,42652-42653,42665,42687,42711,42713,42719,42722,42739-42740,42744,42758,42791-42792,42801,42814,42817-42818,42823,42830,42837,42839,42841,42844,42851-42852,42860,42864,42881,42888-42889,42892-42894,42930,42964,42967,42971-42972,42977-42978
 ,42980,42985-42987,42989,42992,42994-42995,42998-42999,43001-43004,43007-43008,43011-43012,43014-43015,43025,43027,43030,43032,43034,43036,43039,43045-43047,43053-43063,43065,43081,43085,43088-43089,43091,43104,43116
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="branches49srcwpincludesdefaultfiltersphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.9/src/wp-includes/default-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.9/src/wp-includes/default-filters.php  2018-05-02 04:10:17 UTC (rev 43116)
+++ branches/4.9/src/wp-includes/default-filters.php    2018-05-02 04:20:35 UTC (rev 43117)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -325,6 +325,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'user_request_action_confirmed_message', '_wp_privacy_account_request_confirmed_message', 10, 2 );
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'wp_privacy_personal_data_exporters', 'wp_register_comment_personal_data_exporter' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'wp_privacy_personal_data_exporters', 'wp_register_media_personal_data_exporter' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+add_filter( 'wp_privacy_personal_data_exporters', 'wp_register_user_personal_data_exporter' );
</ins><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'wp_privacy_personal_data_erasers', 'wp_register_comment_personal_data_eraser' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'init', 'wp_schedule_delete_old_privacy_export_files' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'wp_privacy_delete_old_export_files', 'wp_privacy_delete_old_export_files' );
</span></span></pre></div>
<a id="branches49srcwpincludesuserphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.9/src/wp-includes/user.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.9/src/wp-includes/user.php     2018-05-02 04:10:17 UTC (rev 43116)
+++ branches/4.9/src/wp-includes/user.php       2018-05-02 04:20:35 UTC (rev 43117)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2748,6 +2748,105 @@
</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">+ * Registers the personal data exporter for users.
+ *
+ * @since 4.9.6
+ *
+ * @param array $exporters  An array of personal data exporters.
+ * @return array An array of personal data exporters.
+ */
+function wp_register_user_personal_data_exporter( $exporters ) {
+       $exporters[] = array(
+               'exporter_friendly_name' => __( 'WordPress User' ),
+               'callback'               => 'wp_user_personal_data_exporter',
+       );
+
+       return $exporters;
+}
+
+/**
+ * Finds and exports personal data associated with an email address from the user and user_meta table.
+ *
+ * @since 4.9.6
+ *
+ * @param string $email_address  The users email address.
+ * @return array An array of personal data.
+ */
+function wp_user_personal_data_exporter( $email_address ) {
+       $email_address = trim( $email_address );
+
+       $data_to_export = array();
+
+       $user = get_user_by( 'email', $email_address );
+
+       if ( ! $user ) {
+               return array(
+                       'data' => array(),
+                       'done' => true,
+               );
+       }
+
+       $user_meta = get_user_meta( $user->ID );
+
+       $user_prop_to_export = array(
+               'ID'              => __( 'User ID' ),
+               'user_login'      => __( 'User Login Name' ),
+               'user_nicename'   => __( 'User Nice Name' ),
+               'user_email'      => __( 'User Email' ),
+               'user_url'        => __( 'User URL' ),
+               'user_registered' => __( 'User Registration Date' ),
+               'display_name'    => __( 'User Display Name' ),
+               'nickname'        => __( 'User Nickname' ),
+               'first_name'      => __( 'User First Name' ),
+               'last_name'       => __( 'User Last Name' ),
+               'description'     => __( 'User Description' ),
+       );
+
+       $user_data_to_export = array();
+
+       foreach ( $user_prop_to_export as $key => $name ) {
+               $value = '';
+
+               switch ( $key ) {
+                       case 'ID':
+                       case 'user_login':
+                       case 'user_nicename':
+                       case 'user_email':
+                       case 'user_url':
+                       case 'user_registered':
+                       case 'display_name':
+                               $value = $user->data->$key;
+                               break;
+                       case 'nickname':
+                       case 'first_name':
+                       case 'last_name':
+                       case 'description':
+                               $value = $user_meta[ $key ][0];
+                               break;
+               }
+
+               if ( ! empty( $value ) ) {
+                       $user_data_to_export[] = array(
+                               'name'  => $name,
+                               'value' => $value,
+                       );
+               }
+       }
+
+       $data_to_export[] = array(
+               'group_id'    => 'user',
+               'group_label' => __( 'User' ),
+               'item_id'     => "user-{$user->ID}",
+               'data'        => $user_data_to_export,
+       );
+
+       return array(
+               'data' => $data_to_export,
+               'done' => true,
+       );
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px">  * Update log when privacy request is confirmed.
</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></pre></div>
<a id="branches49testsphpunittestsuserphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.9/tests/phpunit/tests/user.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.9/tests/phpunit/tests/user.php 2018-05-02 04:10:17 UTC (rev 43116)
+++ branches/4.9/tests/phpunit/tests/user.php   2018-05-02 04:20:35 UTC (rev 43117)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -27,7 +27,9 @@
</span><span class="cx" style="display: block; padding: 0 10px">                        'display_name' => 'John Doe',
</span><span class="cx" style="display: block; padding: 0 10px">                        'user_email' => 'blackburn@battlefield3.com',
</span><span class="cx" style="display: block; padding: 0 10px">                        'user_url' => 'http://tacos.com',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                        'role' => 'contributor'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                 'role' => 'contributor',
+                       'nickname' => 'Johnny',
+                       'description' => 'I am a WordPress user that cares about privacy.',
</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">                self::$user_ids[] = self::$author_id = $factory->user->create( array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1449,4 +1451,40 @@
</span><span class="cx" style="display: block; padding: 0 10px">                $this->assertContains( '\'Test\' blog\'s "name" has <html entities> &', $email->subject, 'Email subject does not contain the decoded HTML entities' );
</span><span class="cx" style="display: block; padding: 0 10px">                $this->assertNotContains( '&#039;Test&#039; blog&#039;s &quot;name&quot; has &lt;html entities&gt; &amp;', $email->subject, 'Email subject does contains HTML entities' );
</span><span class="cx" style="display: block; padding: 0 10px">        }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+       /**
+        * Testing the `wp_user_personal_data_exporter_no_user` function when no user exists.
+        *
+        * @ticket 43547
+        */
+       function test_wp_user_personal_data_exporter_no_user() {
+               $actual = wp_user_personal_data_exporter( 'not-a-user-email@test.com' );
+
+               $expected = array(
+                       'data' => array(),
+                       'done' => true,
+               );
+
+               $this->assertSame( $expected, $actual );
+       }
+
+       /**
+        * Testing the `wp_user_personal_data_exporter_no_user` function when the requested
+        * user exists.
+        *
+        * @ticket 43547
+        */
+       function test_wp_user_personal_data_exporter() {
+               $test_user = new WP_User( self::$contrib_id );
+
+               $actual = wp_user_personal_data_exporter( $test_user->user_email );
+
+               $this->assertTrue( $actual['done'] );
+
+               // Number of exported users.
+               $this->assertSame( 1, count( $actual['data'] ) );
+
+               // Number of exported user properties.
+               $this->assertSame( 11, count( $actual['data'][0]['data'] ) );
+       }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>

</body>
</html>