スキーマ
スキーマは、パターンディレクトリアイテムレコード内に存在するすべてのフィールドを定義します。これらのエンドポイントからの応答には、_filter
クエリパラメータが使用されるか、スキーマフィールドが特定のコンテキストにのみ表示されない限り、以下のフィールドが含まれることが期待されます。
id |
パターンID。 JSONデータタイプ: 整数 コンテキスト: view , edit , embed |
title |
人間が読みやすい形式のパターンタイトル。 JSONデータタイプ: 文字列 コンテキスト: view , edit , embed |
content |
パターンの内容。 JSONデータタイプ: 文字列 コンテキスト: view , edit , embed |
categories |
パターンのカテゴリスラッグ。 JSONデータタイプ: 配列 コンテキスト: view , edit , embed |
keywords |
パターンのキーワード。 JSONデータタイプ: 配列 コンテキスト: view , edit , embed |
description |
パターンの説明。 JSONデータタイプ: 文字列 コンテキスト: view , edit , embed |
viewport_width |
パターンをプレビューする際のビューポートの推奨幅(ピクセル単位)。 JSONデータタイプ: 整数 コンテキスト: view , edit , embed |
block_types |
このパターンを使用できるブロックタイプ。 JSONデータタイプ: 配列 コンテキスト: view , embed |
パターンディレクトリアイテムのリスト
このエンドポイントをクエリして、パターンディレクトリアイテムのコレクションを取得します。受け取る応答は、以下のURLクエリパラメータを使用して制御およびフィルタリングできます。
定義
GET /wp/v2/pattern-directory/patterns
例リクエスト
$ curl https://example.com/wp-json/wp/v2/pattern-directory/patterns
引数
context |
リクエストが行われるスコープ; 応答に存在するフィールドを決定します。 デフォルト: view 一つの: view , embed , edit |
page |
コレクションの現在のページ。 デフォルト: 1 |
per_page |
結果セットに返される最大アイテム数。 デフォルト: 100 |
search |
文字列に一致する結果に制限します。 |
category |
カテゴリIDに一致する結果に制限します。 |
keyword |
キーワードIDに一致する結果に制限します。 |
slug |
パターン(スラッグ)に一致する結果に制限します。 |
offset |
特定のアイテム数で結果セットをオフセットします。 |
order |
ソート属性を昇順または降順にします。 デフォルト: desc 一つの: asc , desc |
orderby |
投稿属性でコレクションをソートします。 デフォルト: date 一つの: author , date , id , include , modified , parent , relevance , slug , include_slugs , title , favorite_count |