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

Timestamp:

06/26/2020 06:38:51 PM (6 years ago)

Author:

johnbillion

Message:

Docs: Miscellaneous docblock improvements.

See #49572.

File:

• trunk/src/wp-admin/includes/class-wp-plugins-list-table.php (modified) (3 diffs)

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

@@ -1012 +1012 @@
                      * @param string   $plugin_file Path to the plugin file relative to the plugins directory.
                      * @param array    $plugin_data An array of plugin data.
-                     * @param string   $status      Status of the plugin. Defaults are 'All', 'Active',
-                     *                              'Inactive', 'Recently Activated', 'Upgrade', 'Must-Use',
-                     *                              'Drop-ins', 'Search', 'Paused'.
+                     * @param string   $status      Status filter currently applied to the plugin list. Possible
+                     *                              values are: 'all', 'active', 'inactive', 'recently_activated',
+                     *                              'upgrade', 'mustuse', 'dropins', 'search', 'paused',
+                     *                              'auto-update-enabled', 'auto-update-disabled'.
                      */
                     $plugin_meta = apply_filters( 'plugin_row_meta', $plugin_meta, $plugin_file, $plugin_data, $status );
@@ -1132 +1133 @@
          * @param string $plugin_file Path to the plugin file relative to the plugins directory.
          * @param array  $plugin_data An array of plugin data.
-         * @param string $status      Status of the plugin. Defaults are 'All', 'Active',
-         *                            'Inactive', 'Recently Activated', 'Upgrade', 'Must-Use',
-         *                            'Drop-ins', 'Search', 'Paused', 'Auto-updates Enabled',
-         *                            'Auto-updates Disabled'.
+         * @param string $status      Status filter currently applied to the plugin list. Possible
+         *                            values are: 'all', 'active', 'inactive', 'recently_activated',
+         *                            'upgrade', 'mustuse', 'dropins', 'search', 'paused',
+         *                            'auto-update-enabled', 'auto-update-disabled'.
          */
         do_action( 'after_plugin_row', $plugin_file, $plugin_data, $status );
@@ -1150 +1151 @@
          * @param string $plugin_file Path to the plugin file relative to the plugins directory.
          * @param array  $plugin_data An array of plugin data.
-         * @param string $status      Status of the plugin. Defaults are 'All', 'Active',
-         *                            'Inactive', 'Recently Activated', 'Upgrade', 'Must-Use',
-         *                            'Drop-ins', 'Search', 'Paused', 'Auto-updates Enabled',
-         *                            'Auto-updates Disabled'.
+         * @param string $status      Status filter currently applied to the plugin list. Possible
+         *                            values are: 'all', 'active', 'inactive', 'recently_activated',
+         *                            'upgrade', 'mustuse', 'dropins', 'search', 'paused',
+         *                            'auto-update-enabled', 'auto-update-disabled'.
          */
         do_action( "after_plugin_row_{$plugin_file}", $plugin_file, $plugin_data, $status );