Changeset 56068

Timestamp:

06/27/2023 04:00:00 PM (17 months ago)

Author:

audrasjb

Message:

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 #57278.

Location:

trunk

Files:

• src/wp-admin/includes/class-wp-plugins-list-table.php (modified) (1 diff)
• tests/phpunit/tests/admin/wpPluginsListTable.php (modified) (4 diffs)

trunk/src/wp-admin/includes/class-wp-plugins-list-table.php

@@ -296 +296 @@
             $plugins['search'] = array_filter( $plugins['all'], array( $this, '_search_callback' ) );
         }
+
+        /**
+         * 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 );
 
         $totals = array();

trunk/tests/phpunit/tests/admin/wpPluginsListTable.php

@@ -20 +20 @@
 
     /**
-     * Creates an admin user before any tests run.
+     * The original value of the `$s` global.
+     *
+     * @var string|null
+     */
+    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.
      */
     public static function set_up_before_class() {
+        global $s;
+
         parent::set_up_before_class();
 
@@ -33 +61 @@
             )
         );
+        self::$original_s = $s;
     }
 
@@ -38 +67 @@
         parent::set_up();
         $this->table = _get_list_table( 'WP_Plugins_List_Table', array( 'screen' => 'plugins' ) );
+    }
+
+    /**
+     * Restores the `$s` global after each test.
+     */
+    public function tear_down() {
+        global $s;
+
+        $s = self::$original_s;
+
+        parent::tear_down();
     }
 
@@ -254 +294 @@
         );
     }
+
+    /**
+     * 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;
+    }
 }