私のブックマーク
ブックマークを追加
ブックマークを削除スキーマ
スキーマは、ウィジェットレコード内に存在するすべてのフィールドを定義します。これらのエンドポイントからの応答には、_filterクエリパラメータが使用されるか、スキーマフィールドが特定のコンテキストにのみ表示されない限り、以下のフィールドが含まれることが期待されます。
id |
ウィジェットのユニーク識別子。 JSONデータ型: 文字列 コンテキスト: view, edit, embed |
id_base |
ウィジェットのタイプ。ウィジェットタイプエンドポイントのIDに対応します。 JSONデータ型: 文字列 コンテキスト: view, edit, embed |
sidebar |
ウィジェットが属するサイドバー。 JSONデータ型: 文字列 コンテキスト: view, edit, embed |
rendered |
ウィジェットのHTML表現。 JSONデータ型: 文字列 読み取り専用 コンテキスト: view, edit, embed |
rendered_form |
ウィジェット管理フォームのHTML表現。 JSONデータ型: 文字列 読み取り専用 コンテキスト: edit |
instance |
ウィジェットのインスタンス設定（サポートされている場合）。 JSONデータ型: オブジェクト コンテキスト: edit |
form_data |
ウィジェット管理フォームからのURLエンコードされたフォームデータ。インスタンスをサポートしないウィジェットを更新するために使用されます。書き込み専用。 JSONデータ型: 文字列 コンテキスト: |
ウィジェットを取得
定義と例リクエスト
GET /wp/v2/widgets
このエンドポイントをクエリして特定のウィジェットレコードを取得します。
$ curl https://example.com/wp-json/wp/v2/widgets
引数
context |
リクエストが行われるスコープ; 応答に存在するフィールドを決定します。 デフォルト: view一つの: view, embed, edit |
sidebar |
ウィジェットを返すためのサイドバー。 |
ウィジェットを作成
引数
id |
ウィジェットのユニーク識別子。 |
id_base |
ウィジェットのタイプ。ウィジェットタイプエンドポイントのIDに対応します。 |
sidebar |
ウィジェットが属するサイドバー。 必須: 1 デフォルト: wp_inactive_widgets |
instance |
ウィジェットのインスタンス設定（サポートされている場合）。 |
form_data |
ウィジェット管理フォームからのURLエンコードされたフォームデータ。インスタンスをサポートしないウィジェットを更新するために使用されます。書き込み専用。 |
定義
POST /wp/v2/widgets
ウィジェットを取得
定義と例リクエスト
GET /wp/v2/widgets/<id>
このエンドポイントをクエリして特定のウィジェットレコードを取得します。
$ curl https://example.com/wp-json/wp/v2/widgets/<id>
引数
context |
リクエストが行われるスコープ; 応答に存在するフィールドを決定します。 デフォルト: view一つの: view, embed, edit |
ウィジェットを更新
引数
id |
ウィジェットのユニーク識別子。 |
id_base |
ウィジェットのタイプ。ウィジェットタイプエンドポイントのIDに対応します。 |
sidebar |
ウィジェットが属するサイドバー。 |
instance |
ウィジェットのインスタンス設定（サポートされている場合）。 |
form_data |
ウィジェット管理フォームからのURLエンコードされたフォームデータ。インスタンスをサポートしないウィジェットを更新するために使用されます。書き込み専用。 |
定義
例リクエスト
ウィジェットを削除
引数
force |
ウィジェットを強制的に削除するか、非アクティブなサイドバーに移動するか。 |
定義
例リクエスト
$ curl -X DELETE https://example.com/wp-json/wp/v2/widgets/<id>
