WP_Plugin_Install_List_Table::prepare_items()

Source

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(),
			)
		);
	}
}

View all references View on Trac View on GitHub