スキーマ

スキーマは、プラグインレコード内に存在するすべてのフィールドを定義します。これらのエンドポイントからの応答には、_filter クエリパラメータが使用されているか、スキーマフィールドが特定のコンテキストにのみ表示されている場合を除き、以下のフィールドが含まれることが期待されます。

plugin プラグインファイル。
JSONデータ型: 文字列
読み取り専用
コンテキスト: view, edit, embed
status プラグインのアクティベーションステータス。
JSONデータ型: 文字列
コンテキスト: view, edit, embed
いずれか: inactive, active
name プラグイン名。
JSONデータ型: 文字列
読み取り専用
コンテキスト: view, edit, embed
plugin_uri プラグインのウェブサイトアドレス。
JSONデータ型: 文字列,
フォーマット: uri

読み取り専用
コンテキスト: view, edit
author プラグインの著者。
JSONデータ型: オブジェクト
読み取り専用
コンテキスト: view, edit
author_uri プラグイン著者のウェブサイトアドレス。
JSONデータ型: 文字列,
フォーマット: uri

読み取り専用
コンテキスト: view, edit
description プラグインの説明。
JSONデータ型: オブジェクト
読み取り専用
コンテキスト: view, edit
version プラグインのバージョン番号。
JSONデータ型: 文字列
読み取り専用
コンテキスト: view, edit
network_only プラグインがネットワーク全体でのみアクティブ化できるかどうか。
JSONデータ型: ブール値
読み取り専用
コンテキスト: view, edit, embed
requires_wp WordPressの最小必要バージョン。
JSONデータ型: 文字列
読み取り専用
コンテキスト: view, edit, embed
requires_php PHPの最小必要バージョン。
JSONデータ型: 文字列
読み取り専用
コンテキスト: view, edit, embed
textdomain プラグインのテキストドメイン。
JSONデータ型: 文字列
読み取り専用
コンテキスト: view, edit

プラグインを取得する

定義と例リクエスト

GET /wp/v2/plugins

このエンドポイントをクエリして特定のプラグインレコードを取得します。

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

引数

context リクエストが行われるスコープ; 応答に含まれるフィールドを決定します。
デフォルト: view

いずれか: view, embed, edit
search 文字列に一致する結果に制限します。
status 指定されたステータスのプラグインに結果を制限します。

プラグインを作成する

引数

slug WordPress.orgプラグインディレクトリスラッグ。
必須: 1
status プラグインのアクティベーションステータス。
デフォルト: inactive

いずれか: inactive, active

定義

POST /wp/v2/plugins

プラグインを取得する

定義と例リクエスト

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

このエンドポイントをクエリして特定のプラグインレコードを取得します。

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

引数

context リクエストが行われるスコープ; 応答に含まれるフィールドを決定します。
デフォルト: view

いずれか: view, embed, edit
plugin

プラグインを更新する

引数

context リクエストが行われるスコープ; 応答に含まれるフィールドを決定します。
デフォルト: view

いずれか: view, embed, edit
plugin
status プラグインのアクティベーションステータス。
いずれか: inactive, active

定義

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

例リクエスト

プラグインを削除する

引数

context リクエストが行われるスコープ; 応答に含まれるフィールドを決定します。
デフォルト: view

いずれか: view, embed, edit
plugin

定義

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

例リクエスト

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