Plugins Edit

Topics

Schema
Retrieve a Plugin
- Definition & Example Request
- Arguments
Create a Plugin
- Arguments
- Definition
Retrieve a Plugin
- Definition & Example Request
- Arguments
Update a Plugin
Delete a Plugin

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.

`plugin` string	The plugin file. Read only Context: `view`, `edit`, `embed`
`status` string	The plugin activation status. Context: `view`, `edit`, `embed` One of: `inactive`, `active`
`name` string	The plugin name. Read only Context: `view`, `edit`, `embed`
`plugin_uri` string, uri	The plugin's website address. Read only Context: `view`, `edit`
`author` object	The plugin author. Read only Context: `view`, `edit`
`author_uri` string, uri	Plugin author's website address. Read only Context: `view`, `edit`
`description` object	The plugin description. Read only Context: `view`, `edit`
`version` string	The plugin version number. Read only Context: `view`, `edit`
`network_only` boolean	Whether the plugin can only be activated network-wide. Read only Context: `view`, `edit`, `embed`
`requires_wp` string	Minimum required version of WordPress. Read only Context: `view`, `edit`, `embed`
`requires_php` string	Minimum required version of PHP. Read only Context: `view`, `edit`, `embed`
`textdomain` string	The plugin's text domain. Read only Context: `view`, `edit`

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

context

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

Default: view

One of: view, embed, edit

plugin

Definition

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

Example Request

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