<!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>[53868] trunk: Administration: Improve performance of List 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/53868">53868</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/53868","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>peterwilsoncc</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-08-09 00:31:09 +0000 (Tue, 09 Aug 2022)</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: Improve performance of List Tables.
Improve the performance of `WP_List_Table::get_column_info()` by adding the primary column to the cached header values. This reduces the number of calls to the `WP_List_Table::get_primary_column_name()` method to once per table in line with the other header getter functions.
Props bobbingwide, chaion07, costdev, mikeschroder, mukesh27, peterwilsoncc, shetheliving, spacedmonkey.
Fixes <a href="https://core.trac.wordpress.org/ticket/34564">#34564</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesclasswplisttablephp">trunk/src/wp-admin/includes/class-wp-list-table.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsadminwpListTablephp">trunk/tests/phpunit/tests/admin/wpListTable.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 2022-08-08 23:42:16 UTC (rev 53867)
+++ trunk/src/wp-admin/includes/class-wp-list-table.php 2022-08-09 00:31:09 UTC (rev 53868)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1108,7 +1108,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function get_column_info() {
</span><span class="cx" style="display: block; padding: 0 10px"> // $_column_headers is already set / cached.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( isset( $this->_column_headers ) && is_array( $this->_column_headers ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if (
+ isset( $this->_column_headers ) &&
+ is_array( $this->_column_headers )
+ ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> /*
</span><span class="cx" style="display: block; padding: 0 10px"> * Backward compatibility for `$_column_headers` format prior to WordPress 4.3.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1116,12 +1119,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * column headers property. This ensures the primary column name is included
</span><span class="cx" style="display: block; padding: 0 10px"> * in plugins setting the property directly in the three item format.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 4 === count( $this->_column_headers ) ) {
+ return $this->_column_headers;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $column_headers = array( array(), array(), array(), $this->get_primary_column_name() );
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $this->_column_headers as $key => $value ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $column_headers[ $key ] = $value;
</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">- return $column_headers;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->_column_headers = $column_headers;
+
+ return $this->_column_headers;
</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"> $columns = get_column_headers( $this->screen );
</span></span></pre></div>
<a id="trunktestsphpunittestsadminwpListTablephp"></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/wpListTable.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/admin/wpListTable.php (rev 0)
+++ trunk/tests/phpunit/tests/admin/wpListTable.php 2022-08-09 00:31:09 UTC (rev 53868)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,107 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group admin
+ *
+ * @covers WP_List_Table
+ */
+class Tests_Admin_WpListTable extends WP_UnitTestCase {
+
+ /**
+ * Tests that `WP_List_Table::get_column_info()` only adds the primary
+ * column header when necessary.
+ *
+ * @ticket 34564
+ *
+ * @dataProvider data_should_only_add_primary_column_when_needed
+ *
+ * @covers WP_List_Table::get_column_info
+ *
+ * @param string $list_class The name of the WP_List_Table child class.
+ * @param array $headers A list of column headers.
+ * @param array $expected The expected column headers.
+ * @param int $expected_hook_count The expected number of times the hook is called.
+ */
+ public function test_should_only_add_primary_column_when_needed( $list_class, $headers, $expected, $expected_hook_count ) {
+ $hook = new MockAction();
+ add_filter( 'list_table_primary_column', array( $hook, 'filter' ) );
+
+ /*
+ * Set a dummy value for the current screen in the admin to prevent
+ * `_get_list_table()` throwing.
+ */
+ $GLOBALS['hook_suffix'] = 'my-hook';
+
+ $list_table = _get_list_table( $list_class );
+
+ $column_headers = new ReflectionProperty( $list_table, '_column_headers' );
+ $column_headers->setAccessible( true );
+ $column_headers->setValue( $list_table, $headers );
+
+ $column_info = new ReflectionMethod( $list_table, 'get_column_info' );
+ $column_info->setAccessible( true );
+
+ $this->assertSame( $expected, $column_info->invoke( $list_table ), 'The actual columns did not match the expected columns' );
+ $this->assertSame( $expected_hook_count, $hook->get_call_count(), 'The hook was not called the expected number of times' );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_should_only_add_primary_column_when_needed() {
+ /*
+ * `WP_Post_Comments_List_Table` overrides `get_column_info()` rather than
+ * use the default `WP_List_Table::get_column_info()`. Therefore it is
+ * untested.
+ */
+ $list_primary_columns = array(
+ 'WP_Application_Passwords_List_Table' => 'name',
+ 'WP_Comments_List_Table' => 'author',
+ 'WP_Links_List_Table' => 'name',
+ 'WP_Media_List_Table' => 'title',
+ 'WP_MS_Sites_List_Table' => 'blogname',
+ 'WP_MS_Themes_List_Table' => 'name',
+ 'WP_MS_Users_List_Table' => 'username',
+ 'WP_Plugin_Install_List_Table' => '',
+ 'WP_Plugins_List_Table' => 'name',
+ 'WP_Posts_List_Table' => 'title',
+ 'WP_Privacy_Data_Export_Requests_List_Table' => 'email',
+ 'WP_Privacy_Data_Removal_Requests_List_Table' => 'email',
+ 'WP_Terms_List_Table' => 'name',
+ 'WP_Theme_Install_List_Table' => '',
+ 'WP_Themes_List_Table' => '',
+ 'WP_Users_List_Table' => 'username',
+ );
+
+ $datasets = array();
+
+ foreach ( $list_primary_columns as $list_class => $primary_column ) {
+ $datasets[ $list_class . ' - three columns' ] = array(
+ 'list_class' => $list_class,
+ 'headers' => array( 'First', 'Second', 'Third' ),
+ 'expected' => array( 'First', 'Second', 'Third', $primary_column ),
+ 'expected_hook_count' => 1,
+ );
+
+ $datasets[ $list_class . ' - four columns' ] = array(
+ 'list_class' => $list_class,
+ 'headers' => array( 'First', 'Second', 'Third', 'Fourth' ),
+ 'expected' => array( 'First', 'Second', 'Third', 'Fourth' ),
+ 'expected_hook_count' => 0,
+ );
+ }
+
+ /*
+ * `WP_MS_Themes_List_Table` and `WP_Plugins_List_Table` override the
+ * `get_primary_column_name()` method rather than use the default
+ * `WP_List_Table::get_primary_column_name()`. Neither include the
+ * `list_table_primary_column` hook.
+ */
+ $datasets['WP_MS_Themes_List_Table - three columns']['expected_hook_count'] = 0;
+ $datasets['WP_Plugins_List_Table - three columns']['expected_hook_count'] = 0;
+
+ return $datasets;
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/admin/wpListTable.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>