スキーマ
スキーマは、検索結果レコード内に存在するすべてのフィールドを定義します。これらのエンドポイントからの応答には、_filter
クエリパラメータが使用されるか、スキーマフィールドが特定のコンテキストにのみ表示されない限り、以下のフィールドが含まれることが期待されます。
id |
オブジェクトの一意の識別子。 JSONデータ型: 整数または文字列 読み取り専用 コンテキスト: view , embed |
title |
オブジェクトのタイトル。 JSONデータ型: 文字列 読み取り専用 コンテキスト: view , embed |
url |
オブジェクトへのURL。 JSONデータ型: 文字列, 形式: uri 読み取り専用 コンテキスト: view , embed |
type |
オブジェクトタイプ。 JSONデータ型: 文字列 読み取り専用 コンテキスト: view , embed 一つの: post , term , post-format |
subtype |
オブジェクトのサブタイプ。 JSONデータ型: 文字列 読み取り専用 コンテキスト: view , embed 一つの: post , page , category , post_tag |
検索結果のリスト
このエンドポイントにクエリを送信して、検索結果のコレクションを取得します。受け取る応答は、以下のURLクエリパラメータを使用して制御およびフィルタリングできます。
定義
例リクエスト
$ curl https://example.com/wp-json/wp/v2/search
引数
context |
リクエストが行われるスコープ; 応答に含まれるフィールドを決定します。 デフォルト: view 一つの: view , embed |
page |
コレクションの現在のページ。 デフォルト: 1 |
per_page |
結果セットに返される最大アイテム数。 デフォルト: 10 |
search |
文字列に一致する結果に制限します。 |
type |
オブジェクトタイプのアイテムに結果を制限します。 デフォルト: post 一つの: post , term , post-format |
subtype |
一つ以上のオブジェクトサブタイプのアイテムに結果を制限します。 デフォルト: any |
exclude |
結果セットから特定のIDを除外します。 |
include |
結果セットを特定のIDに制限します。 |