<!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>[48151] trunk: Administration: Update `WP_List_Table::get_sortable_columns()` to support `asc` and `desc` arguments.</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/48151">48151</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/48151","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>whyisjake</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-06-23 23:13:35 +0000 (Tue, 23 Jun 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'>Administration: Update `WP_List_Table::get_sortable_columns()` to support `asc` and `desc` arguments.
This makes the API a little more clear, whereas setting `false` used to mean `asc` and `true` meant `desc`, you can now use those directly, while maintaining back-compat.
Fixes <a href="https://core.trac.wordpress.org/ticket/45089">#45089</a>.
Props Tkama, SergeyBiryukov, shital-patel, desrosj, birgire, davidbaumwald. </pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesclasswplisttablephp">trunk/src/wp-admin/includes/class-wp-list-table.php</a></li>
<li><a href="#trunktestsphpunittestsadminincludesListTablephp">trunk/tests/phpunit/tests/admin/includesListTable.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesclasswplisttablephp"></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/class-wp-list-table.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-list-table.php 2020-06-23 23:02:09 UTC (rev 48150)
+++ trunk/src/wp-admin/includes/class-wp-list-table.php 2020-06-23 23:13:35 UTC (rev 48151)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -946,12 +946,12 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Get a list of sortable columns. The format is:
- * 'internal-name' => 'orderby'
- * or
- * 'internal-name' => array( 'orderby', true )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Get a list of sortable columns.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The second format will make the initial sorting order be descending
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The format is:
+ * - `'internal-name' => 'orderby'`
+ * - `'internal-name' => array( 'orderby', 'asc' )` - The second element set the initial sorting order.
+ * - `'internal-name' => array( 'orderby', true )` - The second element will make the initial sorting order be descending.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1161,9 +1161,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $class[] = 'sorted';
</span><span class="cx" style="display: block; padding: 0 10px"> $class[] = $current_order;
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $order = $desc_first ? 'desc' : 'asc';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( in_array( strtolower( $desc_first ), array( 'desc', 'asc' ), true ) ) {
+ $order = 'asc' === strtolower( $desc_first ) ? 'desc' : 'asc';
+ } else {
+ $order = $desc_first ? 'desc' : 'asc';
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> $class[] = 'sortable';
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $class[] = $desc_first ? 'asc' : 'desc';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $class[] = 'desc' === $order ? 'asc' : 'desc';
</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"> $column_display_name = '<a href="' . esc_url( add_query_arg( compact( 'orderby', 'order' ), $current_url ) ) . '"><span>' . $column_display_name . '</span><span class="sorting-indicator"></span></a>';
</span></span></pre></div>
<a id="trunktestsphpunittestsadminincludesListTablephp"></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/admin/includesListTable.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/admin/includesListTable.php 2020-06-23 23:02:09 UTC (rev 48150)
+++ trunk/tests/phpunit/tests/admin/includesListTable.php 2020-06-23 23:13:35 UTC (rev 48151)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -293,4 +293,77 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertNotContains( 'id="delete_all"', $output );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @ticket 45089
+ */
+ public function test_sortable_columns() {
+ require_once ABSPATH . 'wp-admin/includes/class-wp-comments-list-table.php';
+
+ $override_sortable_columns = array(
+ 'author' => array( 'comment_author', true ),
+ 'response' => 'comment_post_ID',
+ 'date' => array( 'comment_date', 'dEsC' ), // The ordering support should be case insensitive.
+ );
+
+ // Stub the get_sortable_columns() method.
+ $object = $this->getMockBuilder( 'WP_Comments_List_Table' )
+ ->setConstructorArgs( array( array( 'screen' => 'edit-comments' ) ) )
+ ->setMethods( array( 'get_sortable_columns' ) )
+ ->getMock();
+
+ // Change the null return value of the stubbed get_sortable_columns() method.
+ $object->method( 'get_sortable_columns' )
+ ->willReturn( $override_sortable_columns );
+
+ $output = get_echo( array( $object, 'print_column_headers' ) );
+
+ $this->assertContains( '?orderby=comment_author&order=desc', $output, 'Mismatch of the default link ordering for comment author column. Should be desc.' );
+ $this->assertContains( 'column-author sortable asc', $output, 'Mismatch of CSS classes for the comment author column.' );
+
+ $this->assertContains( '?orderby=comment_post_ID&order=asc', $output, 'Mismatch of the default link ordering for comment response column. Should be asc.' );
+ $this->assertContains( 'column-response sortable desc', $output, 'Mismatch of CSS classes for the comment post ID column.' );
+
+ $this->assertContains( '?orderby=comment_date&order=asc', $output, 'Mismatch of the default link ordering for comment author column. Should be asc.' );
+ $this->assertContains( 'column-date sortable desc', $output, 'Mismatch of CSS classes for the comment date column.' );
+ }
+
+ /**
+ * @ticket 45089
+ */
+ public function test_sortable_columns_with_current_ordering() {
+ require_once ABSPATH . 'wp-admin/includes/class-wp-comments-list-table.php';
+
+ $override_sortable_columns = array(
+ 'author' => array( 'comment_author', false ),
+ 'response' => 'comment_post_ID',
+ 'date' => array( 'comment_date', 'asc' ), // We will override this with current ordering.
+ );
+
+ // Current ordering.
+ $_GET['orderby'] = 'comment_date';
+ $_GET['order'] = 'desc';
+
+ // Stub the get_sortable_columns() method.
+ $object = $this->getMockBuilder( 'WP_Comments_List_Table' )
+ ->setConstructorArgs( array( array( 'screen' => 'edit-comments' ) ) )
+ ->setMethods( array( 'get_sortable_columns' ) )
+ ->getMock();
+
+ // Change the null return value of the stubbed get_sortable_columns() method.
+ $object->method( 'get_sortable_columns' )
+ ->willReturn( $override_sortable_columns );
+
+ $output = get_echo( array( $object, 'print_column_headers' ) );
+
+ $this->assertContains( '?orderby=comment_author&order=asc', $output, 'Mismatch of the default link ordering for comment author column. Should be asc.' );
+ $this->assertContains( 'column-author sortable desc', $output, 'Mismatch of CSS classes for the comment author column.' );
+
+ $this->assertContains( '?orderby=comment_post_ID&order=asc', $output, 'Mismatch of the default link ordering for comment response column. Should be asc.' );
+ $this->assertContains( 'column-response sortable desc', $output, 'Mismatch of CSS classes for the comment post ID column.' );
+
+ $this->assertContains( '?orderby=comment_date&order=asc', $output, 'Mismatch of the current link ordering for comment date column. Should be asc.' );
+ $this->assertContains( 'column-date sorted desc', $output, 'Mismatch of CSS classes for the comment date column.' );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>