云策 WordPress 开发者社区

类文档

WP_Plugin_Install_List_Table

查看官方原文 ↗
💡 云策文档标注

概述

WP_Plugin_Install_List_Table 是 WordPress 核心类，用于在列表表格中显示可安装的插件。它继承自 WP_List_Table，提供插件安装界面的数据准备、显示和交互功能。

关键要点

  • 继承自 WP_List_Table，用于管理插件安装列表的显示和操作。
  • 核心方法包括 prepare_items() 用于准备插件数据，display() 用于渲染表格，以及多个辅助方法如 get_installed_plugins() 获取已安装插件信息。
  • 支持多种插件浏览标签（如 featured、popular、recommended、favorites），并通过 plugins_api 与 WordPress 插件目录交互。
  • 包含权限检查（ajax_user_can() 确保用户有 install_plugins 权限）和错误处理机制。

代码示例

// 示例：使用 WP_Plugin_Install_List_Table 准备和显示插件列表
$plugin_table = new WP_Plugin_Install_List_Table();
$plugin_table->prepare_items();
$plugin_table->display();

注意事项

  • 该类主要用于 WordPress 后台的插件安装页面，开发者可扩展或自定义其行为。
  • 注意使用 filters 如 install_plugins_tabs 和 install_plugins_table_api_args_{$tab} 来修改标签和 API 参数。
  • 确保在调用前用户具有适当权限，避免安全风险。
📄 原文内容

Core class used to implement displaying plugins to install in a list table.

Description

See also

Methods

Name Description
WP_Plugin_Install_List_Table::ajax_user_can –
WP_Plugin_Install_List_Table::display Displays the plugin install table.
WP_Plugin_Install_List_Table::display_rows Generates the list table rows.
WP_Plugin_Install_List_Table::display_tablenav –
WP_Plugin_Install_List_Table::get_columns –
WP_Plugin_Install_List_Table::get_dependencies_notice Returns a notice containing a list of dependencies required by the plugin.
WP_Plugin_Install_List_Table::get_installed_plugin_slugs Returns a list of slugs of installed plugins, if known.
WP_Plugin_Install_List_Table::get_installed_plugins Returns the list of known plugins.
WP_Plugin_Install_List_Table::get_more_details_link Creates a ‘More details’ link for the plugin.
WP_Plugin_Install_List_Table::get_table_classes –
WP_Plugin_Install_List_Table::get_views –
WP_Plugin_Install_List_Table::no_items –
WP_Plugin_Install_List_Table::order_callback –
WP_Plugin_Install_List_Table::prepare_items –
WP_Plugin_Install_List_Table::views Overrides parent views so we can use the filter bar display.

Source

class WP_Plugin_Install_List_Table extends WP_List_Table {


	public $order   = 'ASC';

	public $orderby = null;

	public $groups  = array();


	private $error;


	/**

	 * @return bool

	 */

	public function ajax_user_can() {

		return current_user_can( 'install_plugins' );

	}


	/**

	 * Returns the list of known plugins.

	 *

	 * Uses the transient data from the updates API to determine the known

	 * installed plugins.

	 *

	 * @since 4.9.0

	 *

	 * @return array

	 */

	protected function get_installed_plugins() {

		$plugins = array();


		$plugin_info = get_site_transient( 'update_plugins' );

		if ( isset( $plugin_info->no_update ) ) {

			foreach ( $plugin_info->no_update as $plugin ) {

				if ( isset( $plugin->slug ) ) {

					$plugin->upgrade          = false;

					$plugins[ $plugin->slug ] = $plugin;

				}

			}

		}


		if ( isset( $plugin_info->response ) ) {

			foreach ( $plugin_info->response as $plugin ) {

				if ( isset( $plugin->slug ) ) {

					$plugin->upgrade          = true;

					$plugins[ $plugin->slug ] = $plugin;

				}

			}

		}


		return $plugins;

	}


	/**

	 * Returns a list of slugs of installed plugins, if known.

	 *

	 * Uses the transient data from the updates API to determine the slugs of

	 * known installed plugins. This might be better elsewhere, perhaps even

	 * within get_plugins().

	 *

	 * @since 4.0.0

	 *

	 * @return array

	 */

	protected function get_installed_plugin_slugs() {

		return array_keys( $this->get_installed_plugins() );

	}


	/**

	 * @global array  $tabs

	 * @global string $tab

	 * @global int    $paged

	 * @global string $type

	 * @global string $term

	 */

	public function prepare_items() {

		require_once ABSPATH . 'wp-admin/includes/plugin-install.php';


		global $tabs, $tab, $paged, $type, $term;


		$tab = ! empty( $_REQUEST['tab'] ) ? sanitize_text_field( $_REQUEST['tab'] ) : '';


		$paged = $this->get_pagenum();


		$per_page = 36;


		// These are the tabs which are shown on the page.

		$tabs = array();


		if ( 'search' === $tab ) {

			$tabs['search'] = __( 'Search Results' );

		}


		if ( 'beta' === $tab || str_contains( get_bloginfo( 'version' ), '-' ) ) {

			$tabs['beta'] = _x( 'Beta Testing', 'Plugin Installer' );

		}


		$tabs['featured']    = _x( 'Featured', 'Plugin Installer' );

		$tabs['popular']     = _x( 'Popular', 'Plugin Installer' );

		$tabs['recommended'] = _x( 'Recommended', 'Plugin Installer' );

		$tabs['favorites']   = _x( 'Favorites', 'Plugin Installer' );


		if ( current_user_can( 'upload_plugins' ) ) {

			/*

			 * No longer a real tab. Here for filter compatibility.

			 * Gets skipped in get_views().

			 */

			$tabs['upload'] = __( 'Upload Plugin' );

		}


		$nonmenu_tabs = array( 'plugin-information' ); // Valid actions to perform which do not have a Menu item.


		/**

		 * Filters the tabs shown on the Add Plugins screen.

		 *

		 * @since 2.7.0

		 *

		 * @param string[] $tabs The tabs shown on the Add Plugins screen. Defaults include

		 *                       'featured', 'popular', 'recommended', 'favorites', and 'upload'.

		 */

		$tabs = apply_filters( 'install_plugins_tabs', $tabs );


		/**

		 * Filters tabs not associated with a menu item on the Add Plugins screen.

		 *

		 * @since 2.7.0

		 *

		 * @param string[] $nonmenu_tabs The tabs that don't have a menu item on the Add Plugins screen.

		 */

		$nonmenu_tabs = apply_filters( 'install_plugins_nonmenu_tabs', $nonmenu_tabs );


		// If a non-valid menu tab has been selected, And it's not a non-menu action.

		if ( empty( $tab ) || ( ! isset( $tabs[ $tab ] ) && ! in_array( $tab, (array) $nonmenu_tabs, true ) ) ) {

			$tab = key( $tabs );

		}


		$installed_plugins = $this->get_installed_plugins();


		$args = array(

			'page'     => $paged,

			'per_page' => $per_page,

			// Send the locale to the API so it can provide context-sensitive results.

			'locale'   => get_user_locale(),

		);


		switch ( $tab ) {

			case 'search':

				$type = isset( $_REQUEST['type'] ) ? wp_unslash( $_REQUEST['type'] ) : 'term';

				$term = isset( $_REQUEST['s'] ) ? wp_unslash( $_REQUEST['s'] ) : '';


				switch ( $type ) {

					case 'tag':

						$args['tag'] = sanitize_title_with_dashes( $term );

						break;

					case 'term':

						$args['search'] = $term;

						break;

					case 'author':

						$args['author'] = $term;

						break;

				}


				break;


			case 'featured':

			case 'popular':

			case 'new':

			case 'beta':

				$args['browse'] = $tab;

				break;

			case 'recommended':

				$args['browse'] = $tab;

				// Include the list of installed plugins so we can get relevant results.

				$args['installed_plugins'] = array_keys( $installed_plugins );

				break;


			case 'favorites':

				$action = 'save_wporg_username_' . get_current_user_id();

				if ( isset( $_GET['_wpnonce'] ) && wp_verify_nonce( wp_unslash( $_GET['_wpnonce'] ), $action ) ) {

					$user = isset( $_GET['user'] ) ? wp_unslash( $_GET['user'] ) : get_user_option( 'wporg_favorites' );


					// If the save url parameter is passed with a falsey value, don't save the favorite user.

					if ( ! isset( $_GET['save'] ) || $_GET['save'] ) {

						update_user_meta( get_current_user_id(), 'wporg_favorites', $user );

					}

				} else {

					$user = get_user_option( 'wporg_favorites' );

				}

				if ( $user ) {

					$args['user'] = $user;

				} else {

					$args = false;

				}


				add_action( 'install_plugins_favorites', 'install_plugins_favorites_form', 9, 0 );

				break;


			default:

				$args = false;

				break;

		}


		/**

		 * Filters API request arguments for each Add Plugins screen tab.

		 *

		 * The dynamic portion of the hook name, `$tab`, refers to the plugin install tabs.

		 *

		 * Possible hook names include:

		 *

		 *  - `install_plugins_table_api_args_favorites`

		 *  - `install_plugins_table_api_args_featured`

		 *  - `install_plugins_table_api_args_popular`

		 *  - `install_plugins_table_api_args_recommended`

		 *  - `install_plugins_table_api_args_upload`

		 *  - `install_plugins_table_api_args_search`

		 *  - `install_plugins_table_api_args_beta`

		 *

		 * @since 3.7.0

		 *

		 * @param array|false $args Plugin install API arguments.

		 */

		$args = apply_filters( "install_plugins_table_api_args_{$tab}", $args );


		if ( ! $args ) {

			return;

		}


		$api = plugins_api( 'query_plugins', $args );


		if ( is_wp_error( $api ) ) {

			$this->error = $api;

			return;

		}


		$this->items = $api->plugins;


		if ( $this->orderby ) {

			uasort( $this->items, array( $this, 'order_callback' ) );

		}


		$this->set_pagination_args(

			array(

				'total_items' => $api->info['results'],

				'per_page'    => $args['per_page'],

			)

		);


		if ( isset( $api->info['groups'] ) ) {

			$this->groups = $api->info['groups'];

		}


		if ( $installed_plugins ) {

			$js_plugins = array_fill_keys(

				array( 'all', 'search', 'active', 'inactive', 'recently_activated', 'mustuse', 'dropins' ),

				array()

			);


			$js_plugins['all'] = array_values( wp_list_pluck( $installed_plugins, 'plugin' ) );

			$upgrade_plugins   = wp_filter_object_list( $installed_plugins, array( 'upgrade' => true ), 'and', 'plugin' );


			if ( $upgrade_plugins ) {

				$js_plugins['upgrade'] = array_values( $upgrade_plugins );

			}


			wp_localize_script(

				'updates',

				'_wpUpdatesItemCounts',

				array(

					'plugins' => $js_plugins,

					'totals'  => wp_get_update_data(),

				)

			);

		}

	}


	/**

	 */

	public function no_items() {

		if ( isset( $this->error ) ) {

			$error_message  = '


' . $this->error->get_error_message() . '


';

			$error_message .= '




';

			wp_admin_notice(

				$error_message,

				array(

					'additional_classes' => array( 'inline', 'error' ),

					'paragraph_wrap'     => false,

				)

			);

			?>




			 $text ) {

			$display_tabs[ 'plugin-install-' . $action ] = array(

				'url'     => self_admin_url( 'plugin-install.php?tab=' . $action ),

				'label'   => $text,

				'current' => $action === $tab,

			);

		}

		// No longer a real tab.

		unset( $display_tabs['plugin-install-upload'] );


		return $this->get_views_links( $display_tabs );

	}


	/**

	 * Overrides parent views so we can use the filter bar display.

	 */

	public function views() {

		$views = $this->get_views();


		/** This filter is documented in wp-admin/includes/class-wp-list-table.php */

		$views = apply_filters( "views_{$this->screen->id}", $views );


		$this->screen->render_screen_reader_content( 'heading_views' );


		printf(

			/* translators: %s: https://wordpress.org/plugins/ */

			'


' . __( 'Plugins extend and expand the functionality of WordPress. You may install plugins from the WordPress Plugin Directory right on this page, or upload a plugin in .zip format by clicking the button above.' ) . '


',

			__( 'https://wordpress.org/plugins/' )

		);

		?>




    
		 $view ) {
    
				$views[ $class ] = "t
    

  • $view";
    
			}
    
			echo implode( " 
    • 

    n", $views ) . "

    n";
    
		}
    
		?>
	




		_args['singular'];


		$data_attr = '';


		if ( $singular ) {

			$data_attr = " data-wp-lists='list:$singular'";

		}


		$this->display_tablenav( 'top' );


		?>

<div class="wp-list-table get_table_classes() ); ?>">

		screen->render_screen_reader_content( 'heading_list' );

		?>

	<div id="the-list">

		display_rows_or_placeholder(); ?>

display_tablenav( 'bottom' );
}

/**
* @global string $tab
*
* @param string $which
*/
protected function display_tablenav( $which ) {
if ( 'featured' === $GLOBALS['tab'] ) {
return;
}

if ( 'top' === $which ) {
wp_referer_field();
?>

pagination( $which ); ?>

pagination( $which ); ?>

_args['plural'] );
}

/**
* @return string[] Array of column titles keyed by their column name.
*/
public function get_columns() {
return array();
}

/**
* @param object $plugin_a
* @param object $plugin_b
* @return int
*/
private function order_callback( $plugin_a, $plugin_b ) {
$orderby = $this->orderby;
if ( ! isset( $plugin_a->$orderby, $plugin_b->$orderby ) ) {
return 0;
}

$a = $plugin_a->$orderby;
$b = $plugin_b->$orderby;

if ( $a === $b ) {
return 0;
}

if ( 'DESC' === $this->order ) {
return ( $a < $b ) ? 1 : -1;
} else {
return ( $a array(
'href' => array(),
'title' => array(),
'target' => array(),
),
'abbr' => array( 'title' => array() ),
'acronym' => array( 'title' => array() ),
'code' => array(),
'pre' => array(),
'em' => array(),
'strong' => array(),
'ul' => array(),
'ol' => array(),
'li' => array(),
'p' => array(),
'br' => array(),
);

$plugins_group_titles = array(
'Performance' => _x( 'Performance', 'Plugin installer group title' ),
'Social' => _x( 'Social', 'Plugin installer group title' ),
'Tools' => _x( 'Tools', 'Plugin installer group title' ),
);

$group = null;

foreach ( (array) $this->items as $plugin ) {
if ( is_object( $plugin ) ) {
$plugin = (array) $plugin;
}

// Display the group heading if there is one.
if ( isset( $plugin['group'] ) && $plugin['group'] !== $group ) {
if ( isset( $this->groups[ $plugin['group'] ] ) ) {
$group_name = $this->groups[ $plugin['group'] ];
if ( isset( $plugins_group_titles[ $group_name ] ) ) {
$group_name = $plugins_group_titles[ $group_name ];
}
} else {
$group_name = $plugin['group'];
}

// Starting a new group, close off the divs of the last one.
if ( ! empty( $group ) ) {
echo '