スキーマ
スキーマは、ブロックディレクトリアイテムレコード内に存在するすべてのフィールドを定義します。これらのエンドポイントからの応答には、_filter
クエリパラメータが使用されるか、スキーマフィールドが特定のコンテキストにのみ表示されない限り、以下のフィールドが含まれることが期待されます。
name |
ブロック名、namespace/block-name形式。 JSONデータ型: 文字列 コンテキスト: view |
title |
ブロックタイトル、人間が読みやすい形式。 JSONデータ型: 文字列 コンテキスト: view |
description |
ブロックの短い説明、人間が読みやすい形式。 JSONデータ型: 文字列 コンテキスト: view |
id |
ブロックスラッグ。 JSONデータ型: 文字列 コンテキスト: view |
rating |
ブロックの星評価。 JSONデータ型: 数値 コンテキスト: view |
rating_count |
評価の数。 JSONデータ型: 整数 コンテキスト: view |
active_installs |
このブロックを有効にしたサイトの数。 JSONデータ型: 整数 コンテキスト: view |
author_block_rating |
同じ著者によって公開されたブロックの平均評価。 JSONデータ型: 数値 コンテキスト: view |
author_block_count |
同じ著者によって公開されたブロックの数。 JSONデータ型: 整数 コンテキスト: view |
author |
ブロック著者のWordPress.orgユーザー名。 JSONデータ型: 文字列 コンテキスト: view |
icon |
ブロックアイコン。 JSONデータ型: 文字列, フォーマット: uri コンテキスト: view |
last_updated |
ブロックが最後に更新された日付。 JSONデータ型: 文字列, フォーマット: datetime ( 詳細) コンテキスト: view |
humanized_updated |
ブロックが最後に更新された日付、人間が読みやすい形式での曖昧な表現。 JSONデータ型: 文字列 コンテキスト: view |
ブロックディレクトリアイテムのリスト
このエンドポイントをクエリして、ブロックディレクトリアイテムのコレクションを取得します。受け取る応答は、以下のURLクエリパラメータを使用して制御およびフィルタリングできます。
定義
GET /wp/v2/block-directory/search
例リクエスト
$ curl https://example.com/wp-json/wp/v2/block-directory/search
引数
context |
リクエストが行われるスコープ; 応答に存在するフィールドを決定します。 デフォルト: view 次のいずれか: view |
page |
コレクションの現在のページ。 デフォルト: 1 |
per_page |
結果セットに返される最大アイテム数。 デフォルト: 10 |
term |
検索用語に一致するブロックに結果セットを制限します。 必須: 1 |