Plugins – REST API Handbook | Developer.WordPress.org

Plugins

Schema

The schema defines all the fields that exist within a plugin record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.

Retrieve a Plugin

Definition & Example Request

GET /wp/v2/plugins

Query this endpoint to retrieve a specific plugin record.

$ curl https://example.com/wp-json/wp/v2/plugins

Arguments

context Scope under which the request is made; determines fields present in response.

Default: view

One of: view, embed, edit

search Limit results to those matching a string.
status Limits results to plugins with the given status.

Create a Plugin

Arguments

slug WordPress.org plugin directory slug.

Required: 1

status The plugin activation status.

Default: inactive

One of: inactive, active

Definition

POST /wp/v2/plugins

Retrieve a Plugin

Definition & Example Request

GET /wp/v2/plugins/<plugin>?)

Query this endpoint to retrieve a specific plugin record.

$ curl https://example.com/wp-json/wp/v2/plugins/<plugin>?)

Arguments

context Scope under which the request is made; determines fields present in response.

Default: view

One of: view, embed, edit

plugin

Update a Plugin

Arguments

context Scope under which the request is made; determines fields present in response.

Default: view

One of: view, embed, edit

plugin
status The plugin activation status.
One of: inactive, active

Definition

POST /wp/v2/plugins/<plugin>?)

Example Request

Delete a Plugin

Arguments

Definition

DELETE /wp/v2/plugins/<plugin>?)

Example Request

$ curl -X DELETE https://example.com/wp-json/wp/v2/plugins/<plugin>?)