スキーマ

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

id サイドバーのID。
JSONデータ型: 文字列
読み取り専用
コンテキスト: embed, view, edit
name サイドバーを識別するユニークな名前。
JSONデータ型: 文字列
読み取り専用
コンテキスト: embed, view, edit
description サイドバーの説明。
JSONデータ型: 文字列
読み取り専用
コンテキスト: embed, view, edit
class ウィジェットインターフェースでサイドバーに割り当てる追加のCSSクラス。
JSONデータ型: 文字列
読み取り専用
コンテキスト: embed, view, edit
before_widget このサイドバーに割り当てられた各ウィジェットのHTML出力の前に追加されるHTMLコンテンツ。デフォルトはリストアイテム要素の開始です。
JSONデータ型: 文字列
読み取り専用
コンテキスト: embed, view, edit
after_widget このサイドバーに割り当てられた各ウィジェットのHTML出力の後に追加されるHTMLコンテンツ。デフォルトはリストアイテム要素の終了です。
JSONデータ型: 文字列
読み取り専用
コンテキスト: embed, view, edit
before_title 表示されるときにサイドバーのタイトルの前に追加されるHTMLコンテンツ。デフォルトはh2要素の開始です。
JSONデータ型: 文字列
読み取り専用
コンテキスト: embed, view, edit
after_title 表示されるときにサイドバーのタイトルの後に追加されるHTMLコンテンツ。デフォルトはh2要素の終了です。
JSONデータ型: 文字列
読み取り専用
コンテキスト: embed, view, edit
status サイドバーのステータス。
JSONデータ型: 文字列
読み取り専用
コンテキスト: embed, view, edit
いずれか: active, inactive
widgets ネストされたウィジェット。
JSONデータ型: 配列
コンテキスト: embed, view, edit

サイドバーを取得する

定義と例リクエスト

GET /wp/v2/sidebars

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

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

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

いずれか: view, embed, edit

サイドバーを取得する

定義と例リクエスト

GET /wp/v2/sidebars/<id>

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

$ curl https://example.com/wp-json/wp/v2/sidebars/<id>

引数
id 登録されたサイドバーのID
context リクエストが行われるスコープ; 応答に含まれるフィールドを決定します。
デフォルト: view

いずれか: view, embed, edit

サイドバーを更新する

引数
widgets ネストされたウィジェット。

定義

POST /wp/v2/sidebars/<id>

例リクエスト