<!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>[43055] trunk: 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/43055">43055</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/43055","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>azaozz</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-05-01 13:58:02 +0000 (Tue, 01 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.
See <a href="https://core.trac.wordpress.org/ticket/43547">#43547</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesdefaultfiltersphp">trunk/src/wp-includes/default-filters.php</a></li>
<li><a href="#trunksrcwpincludesuserphp">trunk/src/wp-includes/user.php</a></li>
<li><a href="#trunktestsphpunittestsuserphp">trunk/tests/phpunit/tests/user.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesdefaultfiltersphp"></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/default-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/default-filters.php 2018-05-01 13:44:50 UTC (rev 43054)
+++ trunk/src/wp-includes/default-filters.php 2018-05-01 13:58:02 UTC (rev 43055)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -352,6 +352,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="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 2018-05-01 13:44:50 UTC (rev 43054)
+++ trunk/src/wp-includes/user.php 2018-05-01 13:58:02 UTC (rev 43055)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2826,6 +2826,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="trunktestsphpunittestsuserphp"></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/user.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/user.php 2018-05-01 13:44:50 UTC (rev 43054)
+++ trunk/tests/phpunit/tests/user.php 2018-05-01 13:58:02 UTC (rev 43055)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -29,6 +29,8 @@
</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><span class="cx" style="display: block; padding: 0 10px"> 'role' => 'contributor',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '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">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1580,4 +1582,40 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Should have the new role.
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( array( 'administrator' ), get_userdata( $editor )->roles );
</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( 12, count( $actual['data'][0]['data'] ) );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>