Search-results Edit

Schema Schema

The schema defines all the fields that exist for a search-result object.

id

integer
Unique identifier for the object.

Read only

Context: view, embed

title

string
The title for the object.

Read only

Context: view, embed

url

string,
uri
URL to the object.

Read only

Context: view, embed

type

string
Object type.

Read only

Context: view, embed

One of: post

subtype

string
Object subtype.

Read only

Context: view, embed

One of: post, page

Example Request Example Request

$ curl -X OPTIONS -i https://example.com/wp-json/wp/v2/search

Top ↑

List Search-results List Search-results

Top ↑

Arguments Arguments

context Scope under which the request is made; determines fields present in response.

Default: view

One of: view, embed

page Current page of the collection.

Default: 1

per_page Maximum number of items to be returned in result set.

Default: 10

search Limit results to those matching a string.
type Limit results to items of an object type.

Default: post

One of: post

subtype Limit results to items of one or more object subtypes.

Default: any

Top ↑

Definition Definition

GET /wp/v2/search

Top ↑

Example Request Example Request

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