<!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>[44628] trunk: Privacy: Allow column sorting in the privacy request admin tables.</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/44628">44628</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/44628","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>desrosj</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-01-16 17:51:56 +0000 (Wed, 16 Jan 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: Allow column sorting in the privacy request admin tables.
This allows users to sort the export and erase personal data request tables by {U+201C}Requester{U+201D} (`post_title`, or user email) and {U+201C}Requested{U+201D} (`post_date`, or when the request was created), which can be helpful when sites have many requests present.
Props birgire, ianbelanger, pbiron, desrosj.
Fixes <a href="https://core.trac.wordpress.org/ticket/43405">#43405</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesuserphp">trunk/src/wp-admin/includes/user.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsadminwpPrivacyRequestsTablephp">trunk/tests/phpunit/tests/admin/wpPrivacyRequestsTable.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesuserphp"></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/user.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/user.php 2019-01-16 17:05:37 UTC (rev 44627)
+++ trunk/src/wp-admin/includes/user.php 2019-01-16 17:51:56 UTC (rev 44628)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -809,6 +809,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'plural' => 'privacy_requests',
</span><span class="cx" style="display: block; padding: 0 10px"> 'singular' => 'privacy_request',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'screen' => 'export_personal_data',
</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"> $requests_table->process_bulk_action();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -882,6 +883,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'plural' => 'privacy_requests',
</span><span class="cx" style="display: block; padding: 0 10px"> 'singular' => 'privacy_request',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'screen' => 'remove_personal_data',
</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">@@ -1090,7 +1092,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array Default sortable columns.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function get_sortable_columns() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return array();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // The initial sorting is by 'Requested' (post_date) and descending.
+ // With initial sorting, the first click on 'Requested' should be ascending.
+ // With 'Requester' sorting active, the next click on 'Requested' should be descending.
+ $desc_first = isset( $_GET['orderby'] );
+
+ return array(
+ 'email' => 'requester',
+ 'created_timestamp' => array( 'requested', $desc_first ),
+ );
</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">@@ -1235,18 +1245,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Prepare items to output.
</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.1.0 Added support for column sorting.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function prepare_items() {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $primary = $this->get_primary_column_name();
- $this->_column_headers = array(
- $this->get_columns(),
- array(),
- $this->get_sortable_columns(),
- $primary,
- );
-
</del><span class="cx" style="display: block; padding: 0 10px"> $this->items = array();
</span><span class="cx" style="display: block; padding: 0 10px"> $posts_per_page = $this->get_items_per_page( $this->request_type . '_requests_per_page' );
</span><span class="cx" style="display: block; padding: 0 10px"> $args = array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1258,6 +1261,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 's' => isset( $_REQUEST['s'] ) ? sanitize_text_field( $_REQUEST['s'] ) : '',
</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">+ $orderby_mapping = array(
+ 'requester' => 'post_title',
+ 'requested' => 'post_date',
+ );
+
+ if ( isset( $_REQUEST['orderby'] ) && isset( $orderby_mapping[ $_REQUEST['orderby'] ] ) ) {
+ $args['orderby'] = $orderby_mapping[ $_REQUEST['orderby'] ];
+ }
+
+ if ( isset( $_REQUEST['order'] ) && in_array( strtoupper( $_REQUEST['order'] ), array( 'ASC', 'DESC' ), true ) ) {
+ $args['order'] = strtoupper( $_REQUEST['order'] );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $_REQUEST['filter-status'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $filter_status = isset( $_REQUEST['filter-status'] ) ? sanitize_text_field( $_REQUEST['filter-status'] ) : '';
</span><span class="cx" style="display: block; padding: 0 10px"> $args['post_status'] = $filter_status;
</span></span></pre></div>
<a id="trunktestsphpunittestsadminwpPrivacyRequestsTablephp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/admin/wpPrivacyRequestsTable.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/admin/wpPrivacyRequestsTable.php (rev 0)
+++ trunk/tests/phpunit/tests/admin/wpPrivacyRequestsTable.php 2019-01-16 17:51:56 UTC (rev 44628)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,186 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Test the `WP_Privacy_Requests_Table` class.
+ *
+ * @package WordPress\UnitTests
+ *
+ * @since 5.1.0
+ */
+
+/**
+ * Tests_Admin_WpPrivacyRequestsTable class.
+ *
+ * @group admin
+ * @group privacy
+ *
+ * @since 5.1.0
+ */
+class Tests_Admin_WpPrivacyRequestsTable extends WP_UnitTestCase {
+ /**
+ * Get instance for mocked class.
+ *
+ * @since 5.1.0
+ *
+ * @return PHPUnit_Framework_MockObject_MockObject|WP_Privacy_Requests_Table $instance Mocked class instance.
+ */
+ public function get_mocked_class_instance() {
+ if ( version_compare( PHP_VERSION, '5.3', '<' ) ) {
+ $this->markTestSkipped( 'ReflectionMethod::setAccessible is only available in PHP 5.3+' );
+ }
+
+ $args = array(
+ 'plural' => 'privacy_requests',
+ 'singular' => 'privacy_request',
+ 'screen' => 'export_personal_data',
+ );
+
+ $instance = $this
+ ->getMockBuilder( 'WP_Privacy_Requests_Table' )
+ ->setConstructorArgs( array( $args ) )
+ ->getMockForAbstractClass();
+
+ $reflection = new ReflectionClass( $instance );
+
+ // Set the request type as 'export_personal_data'.
+ $reflection_property = $reflection->getProperty( 'request_type' );
+ $reflection_property->setAccessible( true );
+ $reflection_property->setValue( $instance, 'export_personal_data' );
+
+ // Set the post type as 'user_request'.
+ $reflection_property = $reflection->getProperty( 'post_type' );
+ $reflection_property->setAccessible( true );
+ $reflection_property->setValue( $instance, 'user_request' );
+
+ return $instance;
+ }
+
+ /**
+ * Test columns should be sortable.
+ *
+ * @since 5.1.0
+ *
+ * @param string|null $order Order.
+ * @param string|null $orderby Order by.
+ * @param string|null $search Search term.
+ * @param string $expected Expected in SQL query.
+
+ * @dataProvider data_test_columns_should_be_sortable
+ * @covers WP_Privacy_Requests_Table::prepare_items()
+ * @ticket 43960
+ */
+ public function test_columns_should_be_sortable( $order, $orderby, $search, $expected ) {
+ global $wpdb;
+
+ $table = $this->get_mocked_class_instance();
+ $this->sql = '';
+
+ $_REQUEST['order'] = $order;
+ $_REQUEST['orderby'] = $orderby;
+ $_REQUEST['s'] = $search;
+
+ add_filter( 'posts_request', array( $this, 'filter_posts_request' ) );
+ $table->prepare_items();
+ remove_filter( 'posts_request', array( $this, 'filter_posts_request' ) );
+
+ unset( $_REQUEST['order'] );
+ unset( $_REQUEST['orderby'] );
+ unset( $_REQUEST['s'] );
+
+ $this->assertContains( "ORDER BY {$wpdb->posts}.{$expected}", $this->sql );
+ }
+
+ /**
+ * Filter to grab the complete SQL query.
+ *
+ * @since 5.1.0
+ *
+ * @param string $request The complete SQL query.
+ * @return string $request The complete SQL query.
+ */
+ public function filter_posts_request( $request ) {
+ $this->sql = $request;
+ return $request;
+ }
+
+ /**
+ * Data provider for `test_columns_should_be_sortable()`.
+ *
+ * @since 5.1.0
+ *
+ * @return array {
+ * @type array {
+ * @type string|null Order.
+ * @type string|null Order by.
+ * @type string|null Search term.
+ * @type string Expected in SQL query.
+ * }
+ * }
+ */
+ public function data_test_columns_should_be_sortable() {
+ return array(
+ // Default order (ID) DESC.
+ array(
+ 'order' => null,
+ 'orderby' => null,
+ 's' => null,
+ 'expected' => 'post_date DESC',
+ ),
+ // Default order (ID) DESC.
+ array(
+ 'order' => '',
+ 'orderby' => '',
+ 's' => '',
+ 'expected' => 'post_date DESC',
+ ),
+ // Order by requester (post_title) ASC.
+ array(
+ 'order' => 'ASC',
+ 'orderby' => 'requester',
+ 's' => '',
+ 'expected' => 'post_title ASC',
+ ),
+ // Order by requester (post_title) DESC.
+ array(
+ 'order' => 'DESC',
+ 'orderby' => 'requester',
+ 's' => null,
+ 'expected' => 'post_title DESC',
+ ),
+ // Order by requested (post_date) ASC.
+ array(
+ 'order' => 'ASC',
+ 'orderby' => 'requested',
+ 's' => null,
+ 'expected' => 'post_date ASC',
+ ),
+ // Order by requested (post_date) DESC.
+ array(
+ 'order' => 'DESC',
+ 'orderby' => 'requested',
+ 's' => null,
+ 'expected' => 'post_date DESC',
+ ),
+ // Search and order by relevance.
+ array(
+ 'order' => null,
+ 'orderby' => null,
+ 's' => 'foo',
+ 'expected' => 'post_title LIKE',
+ ),
+ // Search and order by requester (post_title) ASC.
+ array(
+ 'order' => 'ASC',
+ 'orderby' => 'requester',
+ 's' => 'foo',
+ 'expected' => 'post_title ASC',
+ ),
+ // Search and order by requested (post_date) ASC.
+ array(
+ 'order' => 'ASC',
+ 'orderby' => 'requested',
+ 's' => 'foo',
+ 'expected' => 'post_date ASC',
+ ),
+ );
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>