<!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>[47270] trunk: Privacy: Introduce `wp_privacy_additional_user_data` filter to make it easier to include additional user meta in a personal data export.</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/47270">47270</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/47270","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>2020-02-11 18:57:51 +0000 (Tue, 11 Feb 2020)</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_additional_user_data` filter to make it easier to include additional user meta in a personal data export.
Props pbiron, xkon, garrett-eclipse, azaozz.
Fixes <a href="https://core.trac.wordpress.org/ticket/47509">#47509</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<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="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 2020-02-11 18:34:08 UTC (rev 47269)
+++ trunk/src/wp-includes/user.php 2020-02-11 18:57:51 UTC (rev 47270)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3006,6 +3006,52 @@
</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">+ // Get the list of reserved names.
+ $reserved_names = array_values( $user_props_to_export );
+
+ /**
+ * Filter to extend the Users profile data for the privacy exporter.
+ *
+ * @since 5.4.0
+ *
+ * @param array $additional_user_profile_data {
+ * An array of name-value pairs of additional user data items. Default empty array.
+ *
+ * @type string $name The user-facing name of an item name-value pair,e.g. 'IP Address'.
+ * @type string $value The user-facing value of an item data pair, e.g. '50.60.70.0'.
+ * }
+ * @param WP_User $user The user whose data is being exported.
+ * @param string[] $reserved_names An array of reserved names. Any item in `$additional_user_data`
+ * that uses one of these for its `name` will not be included in the export.
+ */
+ $_extra_data = apply_filters( 'wp_privacy_additional_user_profile_data', array(), $user, $reserved_names );
+
+ if ( is_array( $_extra_data ) && ! empty( $_extra_data ) ) {
+ // Remove items that use reserved names.
+ $extra_data = array_filter(
+ $_extra_data,
+ function( $item ) use ( $reserved_names ) {
+ return ! in_array( $item['name'], $reserved_names );
+ }
+ );
+
+ if ( count( $extra_data ) !== count( $_extra_data ) ) {
+ _doing_it_wrong(
+ __FUNCTION__,
+ sprintf(
+ /* translators: %s: wp_privacy_additional_user_profile_data */
+ __( 'Filter %s returned items with reserved names.' ),
+ '<code>wp_privacy_additional_user_profile_data</code>'
+ ),
+ '5.4.0'
+ );
+ }
+
+ if ( ! empty( $extra_data ) ) {
+ $user_data_to_export = array_merge( $user_data_to_export, $extra_data );
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $data_to_export[] = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'group_id' => 'user',
</span><span class="cx" style="display: block; padding: 0 10px"> 'group_label' => __( 'User' ),
</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 2020-02-11 18:34:08 UTC (rev 47269)
+++ trunk/tests/phpunit/tests/user.php 2020-02-11 18:57:51 UTC (rev 47270)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1794,4 +1794,133 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'Last Login', $actual['data'][1]['data'][3]['name'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'January 29, 2020 09:13 AM', $actual['data'][1]['data'][3]['value'] );
</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_privacy_additional_user_profile_data` filter works.
+ *
+ * @ticket 47509
+ */
+ function test_filter_wp_privacy_additional_user_profile_data() {
+ $test_user = new WP_User( self::$contrib_id );
+
+ add_filter( 'wp_privacy_additional_user_profile_data', array( $this, 'export_additional_user_profile_data' ) );
+
+ $actual = wp_user_personal_data_exporter( $test_user->user_email );
+
+ remove_filter( 'wp_privacy_additional_user_profile_data', array( $this, 'export_additional_user_profile_data' ) );
+
+ $this->assertTrue( $actual['done'] );
+
+ // Number of exported users.
+ $this->assertSame( 1, count( $actual['data'] ) );
+
+ // Number of exported user properties (the 11 core properties,
+ // plus 1 additional from the filter).
+ $this->assertSame( 12, count( $actual['data'][0]['data'] ) );
+
+ // Check that the item added by the filter was retained.
+ $this->assertSame(
+ 1,
+ count(
+ wp_list_filter(
+ $actual['data'][0]['data'],
+ array(
+ 'name' => 'Test Additional Data Name',
+ 'value' => 'Test Additional Data Value',
+ )
+ )
+ )
+ );
+
+ // _doing_wrong() should be called because the filter callback
+ // adds a item with a 'name' that is the same as one generated by core.
+ $this->setExpectedIncorrectUsage( 'wp_user_personal_data_exporter' );
+ add_filter( 'wp_privacy_additional_user_profile_data', array( $this, 'export_additional_user_profile_data_with_dup_name' ) );
+
+ $actual = wp_user_personal_data_exporter( $test_user->user_email );
+
+ remove_filter( 'wp_privacy_additional_user_profile_data', array( $this, 'export_additional_user_profile_data' ) );
+
+ $this->assertTrue( $actual['done'] );
+
+ // Number of exported users.
+ $this->assertSame( 1, count( $actual['data'] ) );
+
+ // Number of exported user properties
+ // (the 11 core properties, plus 1 additional from the filter).
+ $this->assertSame( 12, count( $actual['data'][0]['data'] ) );
+
+ // Check that the duplicate 'name' => 'User ID' was stripped.
+ $this->assertSame(
+ 1,
+ count(
+ wp_list_filter(
+ $actual['data'][0]['data'],
+ array(
+ 'name' => 'User ID',
+ )
+ )
+ )
+ );
+
+ // Check that the item added by the filter was retained.
+ $this->assertSame(
+ 1,
+ count(
+ wp_list_filter(
+ $actual['data'][0]['data'],
+ array(
+ 'name' => 'Test Additional Data Name',
+ 'value' => 'Test Additional Data Value',
+ )
+ )
+ )
+ );
+ }
+
+ /**
+ * Filter callback to add additional profile data to the User Group on Export Requests.
+ *
+ * @ticket 47509
+ *
+ * @return array $additional_profile_data The additional user data.
+ */
+ public function export_additional_user_profile_data() {
+ $additional_profile_data = array(
+ // This item should be retained and included in the export.
+ array(
+ 'name' => 'Test Additional Data Name',
+ 'value' => 'Test Additional Data Value',
+ ),
+ );
+
+ return $additional_profile_data;
+ }
+
+ /**
+ * Filter callback to add additional profile data to the User Group on Export Requests.
+ *
+ * This callback should generate a `_doing_it_wrong()`.
+ *
+ * @ticket 47509
+ *
+ * @return array $additional_profile_data The additional user data.
+ */
+ public function export_additional_user_profile_data_with_dup_name() {
+ $additional_profile_data = array(
+ // This item should be stripped out by wp_user_personal_data_exporter()
+ // because it's 'name' duplicates one exported by core.
+ array(
+ 'name' => 'User ID',
+ 'value' => 'Some User ID',
+ ),
+ // This item should be retained and included in the export.
+ array(
+ 'name' => 'Test Additional Data Name',
+ 'value' => 'Test Additional Data Value',
+ ),
+ );
+
+ return $additional_profile_data;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>