WP_REST_Plugins_Controller

Compatibility

Present in every tracked release (6.7.7 to 7.1.0).

Hooks and filters fired · 2

Every hook that fires from inside WP_REST_Plugins_Controller, in the order it appears in the class, grouped by the method that fires it.

Methods · 26

• __construct()Plugins controller constructor.
• register_routes()Registers the routes for the plugins controller.
• get_items_permissions_check()Checks if a given request has access to get plugins.
• get_items()Retrieves a collection of plugins.
• get_item_permissions_check()Checks if a given request has access to get a specific plugin.
• get_item()Retrieves one plugin from the site.
• check_read_permission()Checks if the given plugin can be viewed by the current user.
• create_item_permissions_check()Checks if a given request has access to upload plugins.
• create_item()Uploads a plugin and optionally activates it.
• update_item_permissions_check()Checks if a given request has access to update a specific plugin.
• update_item()Updates one plugin.
• delete_item_permissions_check()Checks if a given request has access to delete a specific plugin.
• delete_item()Deletes one plugin from the site.
• prepare_item_for_response()Prepares the plugin for the REST response.
• prepare_links()Prepares links for the request.
• get_plugin_data()Gets the plugin header data for a plugin.
• get_plugin_status()Get's the activation status for a plugin.
• plugin_status_permission_check()Handle updating a plugin's status.
• handle_plugin_status()Handle updating a plugin's status.
• validate_plugin_param()Checks that the "plugin" parameter is a valid path.
• sanitize_plugin_param()Sanitizes the "plugin" parameter to be a proper plugin file with ".php" appended.
• does_plugin_match_request()Checks if the plugin matches the requested parameters.
• is_plugin_installed()Checks if the plugin is installed.
• is_filesystem_available()Determine if the endpoints are available.
• get_item_schema()Retrieves the plugin's schema, conforming to JSON Schema.
• get_collection_params()Retrieves the query params for the collections.

Source code

View on Trac ↗View on GitHub ↗

17class WP_REST_Plugins_Controller extends WP_REST_Controller {18 19	const PATTERN = '[^.\/]+(?:\/[^.\/]+)?';20 21	/**22	 * Plugins controller constructor.23	 *24	 * @since 5.5.025	 */26	public function __construct() {27		$this->namespace = 'wp/v2';28		$this->rest_base = 'plugins';29	}30 31	/**32	 * Registers the routes for the plugins controller.33	 *34	 * @since 5.5.035	 */36	public function register_routes() {37		register_rest_route(38			$this->namespace,39			'/' . $this->rest_base,40			array(41				array(42					'methods'             => WP_REST_Server::READABLE,43					'callback'            => array( $this, 'get_items' ),44					'permission_callback' => array( $this, 'get_items_permissions_check' ),45					'args'                => $this->get_collection_params(),46				),47				array(48					'methods'             => WP_REST_Server::CREATABLE,49					'callback'            => array( $this, 'create_item' ),50					'permission_callback' => array( $this, 'create_item_permissions_check' ),51					'args'                => array(52						'slug'   => array(53							'type'        => 'string',54							'required'    => true,55							'description' => __( 'WordPress.org plugin directory slug.' ),56							'pattern'     => '[\w\-]+',57						),58						'status' => array(59							'description' => __( 'The plugin activation status.' ),60							'type'        => 'string',61							'enum'        => is_multisite() ? array( 'inactive', 'active', 'network-active' ) : array( 'inactive', 'active' ),62							'default'     => 'inactive',63						),64					),65				),66				'schema' => array( $this, 'get_public_item_schema' ),67			)68		);69 70		register_rest_route(71			$this->namespace,72			'/' . $this->rest_base . '/(?P<plugin>' . self::PATTERN . ')',73			array(74				array(75					'methods'             => WP_REST_Server::READABLE,76					'callback'            => array( $this, 'get_item' ),77					'permission_callback' => array( $this, 'get_item_permissions_check' ),78				),79				array(80					'methods'             => WP_REST_Server::EDITABLE,81					'callback'            => array( $this, 'update_item' ),82					'permission_callback' => array( $this, 'update_item_permissions_check' ),83					'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),84				),85				array(86					'methods'             => WP_REST_Server::DELETABLE,87					'callback'            => array( $this, 'delete_item' ),88					'permission_callback' => array( $this, 'delete_item_permissions_check' ),89				),90				'args'   => array(91					'context' => $this->get_context_param( array( 'default' => 'view' ) ),92					'plugin'  => array(93						'type'              => 'string',94						'pattern'           => self::PATTERN,95						'validate_callback' => array( $this, 'validate_plugin_param' ),96						'sanitize_callback' => array( $this, 'sanitize_plugin_param' ),

Changelog

Introduced in 5.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-plugins-controller.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.