<!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>[56068] trunk: Plugins: Introduce the `plugins_list` filter.</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/56068">56068</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/56068","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>audrasjb</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-06-27 16:00:00 +0000 (Tue, 27 Jun 2023)</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'>Plugins: Introduce the `plugins_list` filter.
This changeset adds the `plugins_list` hook, which can be use to filter the list of plugin displayed on WP Admin Plugins screen.
Props nateallen, fischfood, mukesh27, peterwilsoncc, SergeyBiryukov, audrasjb, costdev, ecorica, zunaid321.
Fixes <a href="https://core.trac.wordpress.org/ticket/57278">#57278</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesclasswppluginslisttablephp">trunk/src/wp-admin/includes/class-wp-plugins-list-table.php</a></li>
<li><a href="#trunktestsphpunittestsadminwpPluginsListTablephp">trunk/tests/phpunit/tests/admin/wpPluginsListTable.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesclasswppluginslisttablephp"></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-plugins-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-plugins-list-table.php 2023-06-27 15:25:00 UTC (rev 56067)
+++ trunk/src/wp-admin/includes/class-wp-plugins-list-table.php 2023-06-27 16:00:00 UTC (rev 56068)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -296,6 +296,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $plugins['search'] = array_filter( $plugins['all'], array( $this, '_search_callback' ) );
</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">+ /**
+ * Filters the array of plugins for the list table.
+ *
+ * @since 6.3.0
+ *
+ * @param array[] $plugins An array of arrays of plugin data, keyed by context.
+ */
+ $plugins = apply_filters( 'plugins_list', $plugins );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $totals = array();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $plugins as $type => $list ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $totals[ $type ] = count( $list );
</span></span></pre></div>
<a id="trunktestsphpunittestsadminwpPluginsListTablephp"></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/wpPluginsListTable.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/admin/wpPluginsListTable.php 2023-06-27 15:25:00 UTC (rev 56067)
+++ trunk/tests/phpunit/tests/admin/wpPluginsListTable.php 2023-06-27 16:00:00 UTC (rev 56068)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -19,9 +19,37 @@
</span><span class="cx" style="display: block; padding: 0 10px"> private static $admin_id;
</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">- * Creates an admin user before any tests run.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The original value of the `$s` global.
+ *
+ * @var string|null
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ private static $original_s;
+
+ /**
+ * @var array
+ */
+ public $fake_plugin = array(
+ 'fake-plugin.php' => array(
+ 'Name' => 'Fake Plugin',
+ 'PluginURI' => 'https://wordpress.org/',
+ 'Version' => '1.0.0',
+ 'Description' => 'A fake plugin for testing.',
+ 'Author' => 'WordPress',
+ 'AuthorURI' => 'https://wordpress.org/',
+ 'TextDomain' => 'fake-plugin',
+ 'DomainPath' => '/languages',
+ 'Network' => false,
+ 'Title' => 'Fake Plugin',
+ 'AuthorName' => 'WordPress',
+ ),
+ );
+
+ /**
+ * Creates an admin user before any tests run and backs up the `$s` global.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public static function set_up_before_class() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ global $s;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> parent::set_up_before_class();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> self::$admin_id = self::factory()->user->create(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -32,6 +60,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'user_email' => 'testadmin@test.com',
</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">+ self::$original_s = $s;
</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"> public function set_up() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -40,6 +69,17 @@
</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">+ * Restores the `$s` global after each test.
+ */
+ public function tear_down() {
+ global $s;
+
+ $s = self::$original_s;
+
+ parent::tear_down();
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 42066
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers WP_Plugins_List_Table::get_views
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -253,4 +293,44 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'Drop-ins' => array( 'dropins' ),
</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">+
+ /**
+ * Tests that WP_Plugins_List_Table::prepare_items()
+ * applies 'plugins_list' filters.
+ *
+ * @ticket 57278
+ *
+ * @covers WP_Plugins_List_Table::prepare_items
+ */
+ public function test_plugins_list_filter() {
+ global $status, $s;
+
+ $old_status = $status;
+ $status = 'mustuse';
+ $s = '';
+
+ add_filter( 'plugins_list', array( $this, 'plugins_list_filter' ), 10, 1 );
+ $this->table->prepare_items();
+ $plugins = $this->table->items;
+ remove_filter( 'plugins_list', array( $this, 'plugins_list_filter' ), 10 );
+
+ // Restore to default.
+ $status = $old_status;
+ $this->table->prepare_items();
+
+ $this->assertSame( $plugins, $this->fake_plugin );
+ }
+
+ /**
+ * Adds a fake plugin to an array of plugins.
+ *
+ * Used as a callback for the 'plugins_list' hook.
+ *
+ * @return array
+ */
+ public function plugins_list_filter( $plugins_list ) {
+ $plugins_list['mustuse'] = $this->fake_plugin;
+
+ return $plugins_list;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>