3 * Plugins List Table class.
6 * @subpackage List_Table
10 class WP_Plugins_List_Table extends WP_List_Table {
18 * @see WP_List_Table::__construct() for more information on default arguments.
20 * @param array $args An associative array of arguments.
22 public function __construct( $args = array() ) {
23 global $status, $page;
25 parent::__construct( array(
26 'plural' => 'plugins',
27 'screen' => isset( $args['screen'] ) ? $args['screen'] : null,
31 if ( isset( $_REQUEST['plugin_status'] ) && in_array( $_REQUEST['plugin_status'], array( 'active', 'inactive', 'recently_activated', 'upgrade', 'mustuse', 'dropins', 'search' ) ) )
32 $status = $_REQUEST['plugin_status'];
34 if ( isset($_REQUEST['s']) )
35 $_SERVER['REQUEST_URI'] = add_query_arg('s', wp_unslash($_REQUEST['s']) );
37 $page = $this->get_pagenum();
40 protected function get_table_classes() {
41 return array( 'widefat', $this->_args['plural'] );
44 public function ajax_user_can() {
45 return current_user_can('activate_plugins');
48 public function prepare_items() {
49 global $status, $plugins, $totals, $page, $orderby, $order, $s;
51 wp_reset_vars( array( 'orderby', 'order', 's' ) );
54 * Filter the full array of plugins to list in the Plugins list table.
60 * @param array $plugins An array of plugins to display in the list table.
63 'all' => apply_filters( 'all_plugins', get_plugins() ),
66 'inactive' => array(),
67 'recently_activated' => array(),
73 $screen = $this->screen;
75 if ( ! is_multisite() || ( $screen->in_admin( 'network' ) && current_user_can( 'manage_network_plugins' ) ) ) {
78 * Filter whether to display the advanced plugins list table.
80 * There are two types of advanced plugins - must-use and drop-ins -
81 * which can be used in a single site or Multisite network.
83 * The $type parameter allows you to differentiate between the type of advanced
84 * plugins to filter the display of. Contexts include 'mustuse' and 'dropins'.
88 * @param bool $show Whether to show the advanced plugins for the specified
89 * plugin type. Default true.
90 * @param string $type The plugin type. Accepts 'mustuse', 'dropins'.
92 if ( apply_filters( 'show_advanced_plugins', true, 'mustuse' ) ) {
93 $plugins['mustuse'] = get_mu_plugins();
96 /** This action is documented in wp-admin/includes/class-wp-plugins-list-table.php */
97 if ( apply_filters( 'show_advanced_plugins', true, 'dropins' ) )
98 $plugins['dropins'] = get_dropins();
100 if ( current_user_can( 'update_plugins' ) ) {
101 $current = get_site_transient( 'update_plugins' );
102 foreach ( (array) $plugins['all'] as $plugin_file => $plugin_data ) {
103 if ( isset( $current->response[ $plugin_file ] ) ) {
104 $plugins['all'][ $plugin_file ]['update'] = true;
105 $plugins['upgrade'][ $plugin_file ] = $plugins['all'][ $plugin_file ];
111 set_transient( 'plugin_slugs', array_keys( $plugins['all'] ), DAY_IN_SECONDS );
113 if ( ! $screen->in_admin( 'network' ) ) {
114 $recently_activated = get_option( 'recently_activated', array() );
116 foreach ( $recently_activated as $key => $time )
117 if ( $time + WEEK_IN_SECONDS < time() )
118 unset( $recently_activated[$key] );
119 update_option( 'recently_activated', $recently_activated );
122 $plugin_info = get_site_transient( 'update_plugins' );
124 foreach ( (array) $plugins['all'] as $plugin_file => $plugin_data ) {
125 // Extra info if known. array_merge() ensures $plugin_data has precedence if keys collide.
126 if ( isset( $plugin_info->response[ $plugin_file ] ) ) {
127 $plugins['all'][ $plugin_file ] = $plugin_data = array_merge( (array) $plugin_info->response[ $plugin_file ], $plugin_data );
128 // Make sure that $plugins['upgrade'] also receives the extra info since it is used on ?plugin_status=upgrade
129 if ( isset( $plugins['upgrade'][ $plugin_file ] ) ) {
130 $plugins['upgrade'][ $plugin_file ] = $plugin_data = array_merge( (array) $plugin_info->response[ $plugin_file ], $plugin_data );
133 } elseif ( isset( $plugin_info->no_update[ $plugin_file ] ) ) {
134 $plugins['all'][ $plugin_file ] = $plugin_data = array_merge( (array) $plugin_info->no_update[ $plugin_file ], $plugin_data );
135 // Make sure that $plugins['upgrade'] also receives the extra info since it is used on ?plugin_status=upgrade
136 if ( isset( $plugins['upgrade'][ $plugin_file ] ) ) {
137 $plugins['upgrade'][ $plugin_file ] = $plugin_data = array_merge( (array) $plugin_info->no_update[ $plugin_file ], $plugin_data );
141 // Filter into individual sections
142 if ( is_multisite() && ! $screen->in_admin( 'network' ) && is_network_only_plugin( $plugin_file ) && ! is_plugin_active( $plugin_file ) ) {
143 // On the non-network screen, filter out network-only plugins as long as they're not individually activated
144 unset( $plugins['all'][ $plugin_file ] );
145 } elseif ( ! $screen->in_admin( 'network' ) && is_plugin_active_for_network( $plugin_file ) ) {
146 // On the non-network screen, filter out network activated plugins
147 unset( $plugins['all'][ $plugin_file ] );
148 } elseif ( ( ! $screen->in_admin( 'network' ) && is_plugin_active( $plugin_file ) )
149 || ( $screen->in_admin( 'network' ) && is_plugin_active_for_network( $plugin_file ) ) ) {
150 // On the non-network screen, populate the active list with plugins that are individually activated
151 // On the network-admin screen, populate the active list with plugins that are network activated
152 $plugins['active'][ $plugin_file ] = $plugin_data;
154 if ( ! $screen->in_admin( 'network' ) && isset( $recently_activated[ $plugin_file ] ) ) {
155 // On the non-network screen, populate the recently activated list with plugins that have been recently activated
156 $plugins['recently_activated'][ $plugin_file ] = $plugin_data;
158 // Populate the inactive list with plugins that aren't activated
159 $plugins['inactive'][ $plugin_file ] = $plugin_data;
165 $plugins['search'] = array_filter( $plugins['all'], array( $this, '_search_callback' ) );
169 foreach ( $plugins as $type => $list )
170 $totals[ $type ] = count( $list );
172 if ( empty( $plugins[ $status ] ) && !in_array( $status, array( 'all', 'search' ) ) )
175 $this->items = array();
176 foreach ( $plugins[ $status ] as $plugin_file => $plugin_data ) {
177 // Translate, Don't Apply Markup, Sanitize HTML
178 $this->items[$plugin_file] = _get_plugin_data_markup_translate( $plugin_file, $plugin_data, false, true );
181 $total_this_page = $totals[ $status ];
184 $orderby = ucfirst( $orderby );
185 $order = strtoupper( $order );
187 uasort( $this->items, array( $this, '_order_callback' ) );
190 $plugins_per_page = $this->get_items_per_page( str_replace( '-', '_', $screen->id . '_per_page' ), 999 );
192 $start = ( $page - 1 ) * $plugins_per_page;
194 if ( $total_this_page > $plugins_per_page )
195 $this->items = array_slice( $this->items, $start, $plugins_per_page );
197 $this->set_pagination_args( array(
198 'total_items' => $total_this_page,
199 'per_page' => $plugins_per_page,
204 * @staticvar string $term
205 * @param array $plugin
208 public function _search_callback( $plugin ) {
210 if ( is_null( $term ) )
211 $term = wp_unslash( $_REQUEST['s'] );
213 foreach ( $plugin as $value ) {
214 if ( false !== stripos( strip_tags( $value ), $term ) ) {
223 * @global string $orderby
224 * @global string $order
225 * @param array $plugin_a
226 * @param array $plugin_b
229 public function _order_callback( $plugin_a, $plugin_b ) {
230 global $orderby, $order;
232 $a = $plugin_a[$orderby];
233 $b = $plugin_b[$orderby];
238 if ( 'DESC' == $order )
239 return ( $a < $b ) ? 1 : -1;
241 return ( $a < $b ) ? -1 : 1;
244 public function no_items() {
247 if ( !empty( $plugins['all'] ) )
248 _e( 'No plugins found.' );
250 _e( 'You do not appear to have any plugins available at this time.' );
253 public function get_columns() {
257 'cb' => !in_array( $status, array( 'mustuse', 'dropins' ) ) ? '<input type="checkbox" />' : '',
258 'name' => __( 'Plugin' ),
259 'description' => __( 'Description' ),
263 protected function get_sortable_columns() {
267 protected function get_views() {
268 global $totals, $status;
270 $status_links = array();
271 foreach ( $totals as $type => $count ) {
277 $text = _nx( 'All <span class="count">(%s)</span>', 'All <span class="count">(%s)</span>', $count, 'plugins' );
280 $text = _n( 'Active <span class="count">(%s)</span>', 'Active <span class="count">(%s)</span>', $count );
282 case 'recently_activated':
283 $text = _n( 'Recently Active <span class="count">(%s)</span>', 'Recently Active <span class="count">(%s)</span>', $count );
286 $text = _n( 'Inactive <span class="count">(%s)</span>', 'Inactive <span class="count">(%s)</span>', $count );
289 $text = _n( 'Must-Use <span class="count">(%s)</span>', 'Must-Use <span class="count">(%s)</span>', $count );
292 $text = _n( 'Drop-ins <span class="count">(%s)</span>', 'Drop-ins <span class="count">(%s)</span>', $count );
295 $text = _n( 'Update Available <span class="count">(%s)</span>', 'Update Available <span class="count">(%s)</span>', $count );
299 if ( 'search' != $type ) {
300 $status_links[$type] = sprintf( "<a href='%s' %s>%s</a>",
301 add_query_arg('plugin_status', $type, 'plugins.php'),
302 ( $type == $status ) ? ' class="current"' : '',
303 sprintf( $text, number_format_i18n( $count ) )
308 return $status_links;
311 protected function get_bulk_actions() {
316 if ( 'active' != $status )
317 $actions['activate-selected'] = $this->screen->in_admin( 'network' ) ? __( 'Network Activate' ) : __( 'Activate' );
319 if ( 'inactive' != $status && 'recent' != $status )
320 $actions['deactivate-selected'] = $this->screen->in_admin( 'network' ) ? __( 'Network Deactivate' ) : __( 'Deactivate' );
322 if ( !is_multisite() || $this->screen->in_admin( 'network' ) ) {
323 if ( current_user_can( 'update_plugins' ) )
324 $actions['update-selected'] = __( 'Update' );
325 if ( current_user_can( 'delete_plugins' ) && ( 'active' != $status ) )
326 $actions['delete-selected'] = __( 'Delete' );
333 * @global string $status
334 * @param string $which
337 public function bulk_actions( $which = '' ) {
340 if ( in_array( $status, array( 'mustuse', 'dropins' ) ) )
343 parent::bulk_actions( $which );
347 * @global string $status
348 * @param string $which
351 protected function extra_tablenav( $which ) {
354 if ( ! in_array($status, array('recently_activated', 'mustuse', 'dropins') ) )
357 echo '<div class="alignleft actions">';
359 if ( ! $this->screen->in_admin( 'network' ) && 'recently_activated' == $status )
360 submit_button( __( 'Clear List' ), 'button', 'clear-recent-list', false );
361 elseif ( 'top' == $which && 'mustuse' == $status )
362 echo '<p>' . sprintf( __( 'Files in the <code>%s</code> directory are executed automatically.' ), str_replace( ABSPATH, '/', WPMU_PLUGIN_DIR ) ) . '</p>';
363 elseif ( 'top' == $which && 'dropins' == $status )
364 echo '<p>' . sprintf( __( 'Drop-ins are advanced plugins in the <code>%s</code> directory that replace WordPress functionality when present.' ), str_replace( ABSPATH, '', WP_CONTENT_DIR ) ) . '</p>';
369 public function current_action() {
370 if ( isset($_POST['clear-recent-list']) )
371 return 'clear-recent-list';
373 return parent::current_action();
376 public function display_rows() {
379 if ( is_multisite() && ! $this->screen->in_admin( 'network' ) && in_array( $status, array( 'mustuse', 'dropins' ) ) )
382 foreach ( $this->items as $plugin_file => $plugin_data )
383 $this->single_row( array( $plugin_file, $plugin_data ) );
387 * @global string $status
390 * @global array $totals
393 public function single_row( $item ) {
394 global $status, $page, $s, $totals;
396 list( $plugin_file, $plugin_data ) = $item;
398 $screen = $this->screen;
409 if ( 'mustuse' == $context ) {
411 } elseif ( 'dropins' == $context ) {
412 $dropins = _get_dropins();
413 $plugin_name = $plugin_file;
414 if ( $plugin_file != $plugin_data['Name'] )
415 $plugin_name .= '<br/>' . $plugin_data['Name'];
416 if ( true === ( $dropins[ $plugin_file ][1] ) ) { // Doesn't require a constant
418 $description = '<p><strong>' . $dropins[ $plugin_file ][0] . '</strong></p>';
419 } elseif ( defined( $dropins[ $plugin_file ][1] ) && constant( $dropins[ $plugin_file ][1] ) ) { // Constant is true
421 $description = '<p><strong>' . $dropins[ $plugin_file ][0] . '</strong></p>';
424 $description = '<p><strong>' . $dropins[ $plugin_file ][0] . ' <span class="attention">' . __('Inactive:') . '</span></strong> ' . sprintf( __( 'Requires <code>%s</code> in <code>wp-config.php</code>.' ), "define('" . $dropins[ $plugin_file ][1] . "', true);" ) . '</p>';
426 if ( $plugin_data['Description'] )
427 $description .= '<p>' . $plugin_data['Description'] . '</p>';
429 if ( $screen->in_admin( 'network' ) )
430 $is_active = is_plugin_active_for_network( $plugin_file );
432 $is_active = is_plugin_active( $plugin_file );
434 if ( $screen->in_admin( 'network' ) ) {
436 if ( current_user_can( 'manage_network_plugins' ) )
437 $actions['deactivate'] = '<a href="' . wp_nonce_url('plugins.php?action=deactivate&plugin=' . $plugin_file . '&plugin_status=' . $context . '&paged=' . $page . '&s=' . $s, 'deactivate-plugin_' . $plugin_file) . '" title="' . esc_attr__('Deactivate this plugin') . '">' . __('Network Deactivate') . '</a>';
439 if ( current_user_can( 'manage_network_plugins' ) )
440 $actions['activate'] = '<a href="' . wp_nonce_url('plugins.php?action=activate&plugin=' . $plugin_file . '&plugin_status=' . $context . '&paged=' . $page . '&s=' . $s, 'activate-plugin_' . $plugin_file) . '" title="' . esc_attr__('Activate this plugin for all sites in this network') . '" class="edit">' . __('Network Activate') . '</a>';
441 if ( current_user_can( 'delete_plugins' ) && ! is_plugin_active( $plugin_file ) )
442 $actions['delete'] = '<a href="' . wp_nonce_url('plugins.php?action=delete-selected&checked[]=' . $plugin_file . '&plugin_status=' . $context . '&paged=' . $page . '&s=' . $s, 'bulk-plugins') . '" title="' . esc_attr__('Delete this plugin') . '" class="delete">' . __('Delete') . '</a>';
446 $actions['deactivate'] = '<a href="' . wp_nonce_url('plugins.php?action=deactivate&plugin=' . $plugin_file . '&plugin_status=' . $context . '&paged=' . $page . '&s=' . $s, 'deactivate-plugin_' . $plugin_file) . '" title="' . esc_attr__('Deactivate this plugin') . '">' . __('Deactivate') . '</a>';
448 $actions['activate'] = '<a href="' . wp_nonce_url('plugins.php?action=activate&plugin=' . $plugin_file . '&plugin_status=' . $context . '&paged=' . $page . '&s=' . $s, 'activate-plugin_' . $plugin_file) . '" title="' . esc_attr__('Activate this plugin') . '" class="edit">' . __('Activate') . '</a>';
450 if ( ! is_multisite() && current_user_can('delete_plugins') )
451 $actions['delete'] = '<a href="' . wp_nonce_url('plugins.php?action=delete-selected&checked[]=' . $plugin_file . '&plugin_status=' . $context . '&paged=' . $page . '&s=' . $s, 'bulk-plugins') . '" title="' . esc_attr__('Delete this plugin') . '" class="delete">' . __('Delete') . '</a>';
452 } // end if $is_active
454 } // end if $screen->in_admin( 'network' )
456 if ( ( ! is_multisite() || $screen->in_admin( 'network' ) ) && current_user_can('edit_plugins') && is_writable(WP_PLUGIN_DIR . '/' . $plugin_file) )
457 $actions['edit'] = '<a href="plugin-editor.php?file=' . $plugin_file . '" title="' . esc_attr__('Open this file in the Plugin Editor') . '" class="edit">' . __('Edit') . '</a>';
460 $prefix = $screen->in_admin( 'network' ) ? 'network_admin_' : '';
463 * Filter the action links displayed for each plugin in the Plugins list table.
465 * The dynamic portion of the hook name, `$prefix`, refers to the context the
466 * action links are displayed in. The 'network_admin_' prefix is used if the
467 * current screen is the Network plugins list table. The prefix is empty ('')
468 * if the current screen is the site plugins list table.
470 * The default action links for the Network plugins list table include
471 * 'Network Activate', 'Network Deactivate', 'Edit', and 'Delete'.
473 * The default action links for the site plugins list table include
474 * 'Activate', 'Deactivate', and 'Edit', for a network site, and
475 * 'Activate', 'Deactivate', 'Edit', and 'Delete' for a single site.
479 * @param array $actions An array of plugin action links.
480 * @param string $plugin_file Path to the plugin file.
481 * @param array $plugin_data An array of plugin data.
482 * @param string $context The plugin context. Defaults are 'All', 'Active',
483 * 'Inactive', 'Recently Activated', 'Upgrade',
484 * 'Must-Use', 'Drop-ins', 'Search'.
486 $actions = apply_filters( $prefix . 'plugin_action_links', array_filter( $actions ), $plugin_file, $plugin_data, $context );
489 * Filter the list of action links displayed for a specific plugin.
491 * The first dynamic portion of the hook name, $prefix, refers to the context
492 * the action links are displayed in. The 'network_admin_' prefix is used if the
493 * current screen is the Network plugins list table. The prefix is empty ('')
494 * if the current screen is the site plugins list table.
496 * The second dynamic portion of the hook name, $plugin_file, refers to the path
497 * to the plugin file, relative to the plugins directory.
501 * @param array $actions An array of plugin action links.
502 * @param string $plugin_file Path to the plugin file.
503 * @param array $plugin_data An array of plugin data.
504 * @param string $context The plugin context. Defaults are 'All', 'Active',
505 * 'Inactive', 'Recently Activated', 'Upgrade',
506 * 'Must-Use', 'Drop-ins', 'Search'.
508 $actions = apply_filters( $prefix . "plugin_action_links_$plugin_file", $actions, $plugin_file, $plugin_data, $context );
510 $class = $is_active ? 'active' : 'inactive';
511 $checkbox_id = "checkbox_" . md5($plugin_data['Name']);
512 if ( in_array( $status, array( 'mustuse', 'dropins' ) ) ) {
515 $checkbox = "<label class='screen-reader-text' for='" . $checkbox_id . "' >" . sprintf( __( 'Select %s' ), $plugin_data['Name'] ) . "</label>"
516 . "<input type='checkbox' name='checked[]' value='" . esc_attr( $plugin_file ) . "' id='" . $checkbox_id . "' />";
518 if ( 'dropins' != $context ) {
519 $description = '<p>' . ( $plugin_data['Description'] ? $plugin_data['Description'] : ' ' ) . '</p>';
520 $plugin_name = $plugin_data['Name'];
523 $id = sanitize_title( $plugin_name );
524 if ( ! empty( $totals['upgrade'] ) && ! empty( $plugin_data['update'] ) )
527 $plugin_slug = ( isset( $plugin_data['slug'] ) ) ? $plugin_data['slug'] : '';
528 printf( "<tr id='%s' class='%s' data-slug='%s'>",
534 list( $columns, $hidden ) = $this->get_column_info();
536 foreach ( $columns as $column_name => $column_display_name ) {
538 if ( in_array( $column_name, $hidden ) )
539 $style = ' style="display:none;"';
541 switch ( $column_name ) {
543 echo "<th scope='row' class='check-column'>$checkbox</th>";
546 echo "<td class='plugin-title'$style><strong>$plugin_name</strong>";
547 echo $this->row_actions( $actions, true );
551 echo "<td class='column-description desc'$style>
552 <div class='plugin-description'>$description</div>
553 <div class='$class second plugin-version-author-uri'>";
555 $plugin_meta = array();
556 if ( !empty( $plugin_data['Version'] ) )
557 $plugin_meta[] = sprintf( __( 'Version %s' ), $plugin_data['Version'] );
558 if ( !empty( $plugin_data['Author'] ) ) {
559 $author = $plugin_data['Author'];
560 if ( !empty( $plugin_data['AuthorURI'] ) )
561 $author = '<a href="' . $plugin_data['AuthorURI'] . '">' . $plugin_data['Author'] . '</a>';
562 $plugin_meta[] = sprintf( __( 'By %s' ), $author );
565 // Details link using API info, if available
566 if ( isset( $plugin_data['slug'] ) && current_user_can( 'install_plugins' ) ) {
567 $plugin_meta[] = sprintf( '<a href="%s" class="thickbox" aria-label="%s" data-title="%s">%s</a>',
568 esc_url( network_admin_url( 'plugin-install.php?tab=plugin-information&plugin=' . $plugin_data['slug'] .
569 '&TB_iframe=true&width=600&height=550' ) ),
570 esc_attr( sprintf( __( 'More information about %s' ), $plugin_name ) ),
571 esc_attr( $plugin_name ),
574 } elseif ( ! empty( $plugin_data['PluginURI'] ) ) {
575 $plugin_meta[] = sprintf( '<a href="%s">%s</a>',
576 esc_url( $plugin_data['PluginURI'] ),
577 __( 'Visit plugin site' )
582 * Filter the array of row meta for each plugin in the Plugins list table.
586 * @param array $plugin_meta An array of the plugin's metadata,
587 * including the version, author,
588 * author URI, and plugin URI.
589 * @param string $plugin_file Path to the plugin file, relative to the plugins directory.
590 * @param array $plugin_data An array of plugin data.
591 * @param string $status Status of the plugin. Defaults are 'All', 'Active',
592 * 'Inactive', 'Recently Activated', 'Upgrade', 'Must-Use',
593 * 'Drop-ins', 'Search'.
595 $plugin_meta = apply_filters( 'plugin_row_meta', $plugin_meta, $plugin_file, $plugin_data, $status );
596 echo implode( ' | ', $plugin_meta );
601 echo "<td class='$column_name column-$column_name'$style>";
604 * Fires inside each custom column of the Plugins list table.
608 * @param string $column_name Name of the column.
609 * @param string $plugin_file Path to the plugin file.
610 * @param array $plugin_data An array of plugin data.
612 do_action( 'manage_plugins_custom_column', $column_name, $plugin_file, $plugin_data );
620 * Fires after each row in the Plugins list table.
624 * @param string $plugin_file Path to the plugin file, relative to the plugins directory.
625 * @param array $plugin_data An array of plugin data.
626 * @param string $status Status of the plugin. Defaults are 'All', 'Active',
627 * 'Inactive', 'Recently Activated', 'Upgrade', 'Must-Use',
628 * 'Drop-ins', 'Search'.
630 do_action( 'after_plugin_row', $plugin_file, $plugin_data, $status );
633 * Fires after each specific row in the Plugins list table.
635 * The dynamic portion of the hook name, `$plugin_file`, refers to the path
636 * to the plugin file, relative to the plugins directory.
640 * @param string $plugin_file Path to the plugin file, relative to the plugins directory.
641 * @param array $plugin_data An array of plugin data.
642 * @param string $status Status of the plugin. Defaults are 'All', 'Active',
643 * 'Inactive', 'Recently Activated', 'Upgrade', 'Must-Use',
644 * 'Drop-ins', 'Search'.
646 do_action( "after_plugin_row_$plugin_file", $plugin_file, $plugin_data, $status );