WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Plugins_Controller::get_items()

WP_REST_Plugins_Controller::get_items( WP_REST_Request $request ): WP_REST_Response|WP_Error

In this article

Back to top

Retrieves a collection of plugins.

Parameters

$requestWP_REST_Requestrequired
Full details about the request.

Return

WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.

Source

public function get_items( $request ) {	require_once ABSPATH . 'wp-admin/includes/plugin.php';	$plugins = array();	foreach ( get_plugins() as $file => $data ) {	if ( is_wp_error( $this->check_read_permission( $file ) ) ) {	continue;	}	$data['_file'] = $file;	if ( ! $this->does_plugin_match_request( $request, $data ) ) {	continue;	}	$plugins[] = $this->prepare_response_for_collection( $this->prepare_item_for_response( $data, $request ) );	}	return new WP_REST_Response( $plugins ); }

View all references View on Trac View on GitHub

UsesDescription
WP_REST_Plugins_Controller::does_plugin_match_request()wp-includes/rest-api/endpoints/class-wp-rest-plugins-controller.php

Checks if the plugin matches the requested parameters.

WP_REST_Plugins_Controller::check_read_permission()wp-includes/rest-api/endpoints/class-wp-rest-plugins-controller.php

Checks if the given plugin can be viewed by the current user.

WP_REST_Plugins_Controller::prepare_item_for_response()wp-includes/rest-api/endpoints/class-wp-rest-plugins-controller.php

Prepares the plugin for the REST response.

get_plugins()wp-admin/includes/plugin.php

Checks the plugins directory and retrieve all plugin files with plugin data.

is_wp_error()wp-includes/load.php

Checks whether the given variable is a WordPress Error.

Show 1 moreShow less

Changelog

VersionDescription
5.5.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.