Plugins
Edit
Topics
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
|
The plugin file.
JSON data type: string Read only Context: |
status
|
The plugin activation status.
JSON data type: string Context: One of: |
name
|
The plugin name.
JSON data type: string Read only Context: |
plugin_uri
|
The plugin's website address.
JSON data type: string, Read only Context: |
author
|
The plugin author.
JSON data type: object Read only Context: |
author_uri
|
Plugin author's website address.
JSON data type: string, Read only Context: |
description
|
The plugin description.
JSON data type: object Read only Context: |
version
|
The plugin version number.
JSON data type: string Read only Context: |
network_only
|
Whether the plugin can only be activated network-wide.
JSON data type: boolean Read only Context: |
requires_wp
|
Minimum required version of WordPress.
JSON data type: string Read only Context: |
requires_php
|
Minimum required version of PHP.
JSON data type: string Read only Context: |
textdomain
|
The plugin's text domain.
JSON data type: string Read only 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
Create a Plugin
Arguments
slug
|
WordPress.org plugin directory slug.
Required: 1 |
status
|
The plugin activation status.
Default: One of: |
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>?)
Update a Plugin
Arguments
context
|
Scope under which the request is made; determines fields present in response.
Default: One of: |
plugin
|
|
status
|
The plugin activation status. One of: inactive , active
|
Delete a Plugin
Arguments
context
|
Scope under which the request is made; determines fields present in response.
Default: One of: |
plugin
|
Definition
DELETE /wp/v2/plugins/<plugin>?)
Example Request
$ curl -X DELETE https://example.com/wp-json/wp/v2/plugins/<plugin>?)