WordPress REST API

https://github.com/wp-api/docs
Admin
This repository contains the source for the documentation of the WordPress REST API, hosted on...
Tokens:189,397
Snippets:1,464
Trust Score:8.8
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### GET /wp/v2/media

Source: https://github.com/wp-api/docs/blob/master/reference/media.md

Documentation for the GET /wp/v2/media endpoint, including its query parameters and an example request.

```APIDOC
## [GET] /wp/v2/media

### Description
Retrieves a collection of media items.

### Method
GET

### Endpoint
/wp/v2/media

### Parameters
#### Query Parameters
- **context** (string) - Optional - Scope under which the request is made; determines fields present in response. Default: `view`. One of: `view`, `embed`, `edit`.
- **page** (integer) - Optional - Current page of the collection. Default: `1`.
- **per_page** (integer) - Optional - Maximum number of items to be returned in result set. Default: `10`.
- **search** (string) - Optional - Limit results to those matching a string.
- **after** (string) - Optional - Limit response to posts published after a given ISO8601 compliant date.
- **modified_after** (string) - Optional - Limit response to posts modified after a given ISO8601 compliant date.
- **author** (integer/array) - Optional - Limit result set to posts assigned to specific authors.
- **author_exclude** (integer/array) - Optional - Ensure result set excludes posts assigned to specific authors.
- **before** (string) - Optional - Limit response to posts published before a given ISO8601 compliant date.
- **modified_before** (string) - Optional - Limit response to posts modified before a given ISO8601 compliant date.
- **exclude** (integer/array) - Optional - Ensure result set excludes specific IDs.
- **include** (integer/array) - Optional - Limit result set to specific IDs.
- **offset** (integer) - Optional - Offset the result set by a specific number of items.
- **order** (string) - Optional - Order sort attribute ascending or descending. Default: `desc`. One of: `asc`, `desc`.
- **orderby** (string) - Optional - Sort collection by post attribute. Default: `date`. One of: `author`, `date`, `id`, `include`, `modified`, `parent`, `relevance`, `slug`, `include_slugs`, `title`.
- **parent** (integer/array) - Optional - Limit result set to items with particular parent IDs.
- **parent_exclude** (integer/array) - Optional - Limit result set to all items except those of a particular parent ID.
- **search_columns** (array) - Optional - Array of column names to be searched.
- **slug** (string/array) - Optional - Limit result set to posts with one or more specific slugs.
- **status** (string/array) - Optional - Limit result set to posts assigned one or more statuses. Default: `inherit`.
- **media_type** (string) - Optional - Limit result set to items of a particular media type.

### Request Example
```
$ curl https://example.com/wp-json/wp/v2/media
```

### Response
#### Success Response (200)
A collection of media items.

#### Response Example
(Not provided in source)

```

--------------------------------

### Example Request to List Nav_Menu_Items

Source: https://github.com/wp-api/docs/blob/master/reference/nav_menu_items.md

Example request to list nav_menu_items using curl.

```bash
$ curl https://example.com/wp-json/wp/v2/menu-items
```

--------------------------------

### List Search Results: GET /wp/v2/search and curl example

Source: https://github.com/wp-api/docs/blob/master/reference/search-results.md

The endpoint definition and an example curl request for listing search results. The curl command queries the WordPress REST API search endpoint.

```http
GET /wp/v2/search
```

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

--------------------------------

### Retrieve a Theme - GET /wp/v2/themes/<stylesheet>

Source: https://github.com/wp-api/docs/blob/master/reference/themes.md

Query this endpoint to retrieve a specific theme record. The example request uses curl to send a GET request to the WordPress REST API.

```http
GET /wp/v2/themes/<stylesheet>?)
```

```bash
$ curl https://example.com/wp-json/wp/v2/themes/<stylesheet>?)
```

--------------------------------

### Retrieve a Template: curl example

Source: https://github.com/wp-api/docs/blob/master/reference/wp_templates.md

Example curl command to retrieve a template record from the WordPress REST API.

```bash
$ curl https://example.com/wp-json/wp/v2/templates
```

--------------------------------

### Retrieve a Post: curl Example

Source: https://github.com/wp-api/docs/blob/master/reference/posts.md

Example curl command to retrieve a post. Replace <id> with the actual post ID.

```bash
$ curl https://example.com/wp-json/wp/v2/posts/<id>
```

--------------------------------

### GET /wp/v2/media endpoint

Source: https://github.com/wp-api/docs/blob/master/reference/media.md

Retrieves a collection of media items. The example request uses curl to fetch the media list from a WordPress site.

```http
GET /wp/v2/media
```

```bash
$ curl https://example.com/wp-json/wp/v2/media
```

--------------------------------

### Example: /my-colors/v1/colors endpoint with validation callback

Source: https://github.com/wp-api/docs/blob/master/extending-the-rest-api/routes-and-endpoints.md

This example registers a read-only endpoint that returns a list of colors, with a `filter` argument that is validated as a string and must be one of 'red', 'green', or 'blue'.

```APIDOC
## GET /my-colors/v1/colors

### Description
Retrieves a collection of colors, optionally filtered by the `filter` argument. The `filter` argument is validated to ensure it is a string and one of the allowed enum values.

### Method
GET

### Endpoint
`/my-colors/v1/colors`

### Parameters
#### Query Parameters
- **filter** (string) - Optional - The color to filter by. Must be one of `red`, `green`, or `blue`.

### Request Example

```http
GET /wp-json/my-colors/v1/colors?filter=red
```

### Response
#### Success Response (200)
- **body** (array of strings) - The list of colors matching the filter, or all colors if no filter is provided. Each color is a string.

#### Response Example

```json
["red","red"]
```

### Validation Details
The `validate_callback` function `prefix_filter_arg_validate_callback` performs the following checks:
1. If the `filter` argument is not a string, returns a `WP_Error` with code `rest_invalid_param` and status 400.
2. If the `filter` value is not in the registered `enum` array (`['red', 'green', 'blue']`), returns a `WP_Error` with code `rest_invalid_param` and status 400.

### Registration Code

```php
function prefix_register_example_routes() {
    register_rest_route( 'my-colors/v1', '/colors', array(
        'methods'  => WP_REST_Server::READABLE,
        'callback' => 'prefix_get_colors',
        'args' => prefix_get_color_arguments(),
    ) );
}
add_action( 'rest_api_init', 'prefix_register_example_routes' );
```
```

--------------------------------

### curl example

Source: https://github.com/wp-api/docs/blob/master/bin/templates/reference-parts/get-item.html

Example curl command to retrieve a specific {{ name }} record. Replace the URL with the actual endpoint.

```bash
$ curl https://example.com/wp-json{{ route.nicename }}
```

--------------------------------

### List Navigations with GET /wp/v2/navigation

Source: https://github.com/wp-api/docs/blob/master/reference/wp_navigations.md

Retrieve a collection of navigations. The endpoint supports query parameters such as context, page, per_page, search, after, modified_after, before, modified_before, exclude, include, offset, order, orderby, search_columns, slug, and status. The example request uses curl to fetch the default list.

```http
GET /wp/v2/navigation
```

```bash
$ curl https://example.com/wp-json/wp/v2/navigation
```

--------------------------------

### Retrieve a Comment - Example Request

Source: https://github.com/wp-api/docs/blob/master/reference/comments.md

Example curl command to retrieve a comment. Replace <id> with the comment ID.

```bash
$ curl https://example.com/wp-json/wp/v2/comments/<id>
```

--------------------------------

### Example Response with _embedded

Source: https://github.com/wp-api/docs/blob/master/using-the-rest-api/linking-and-embedding.md

Example response showing the _embedded property when the _embed query parameter is used. The embedded author resource is included adjacent to _links, mirroring the _links layout.

```json
{
  "id": 42,
  "_links": {
    "collection": [
      {
        "href": "https://example.com/wp-json/wp/v2/posts"
      }
    ],
    "author": [
      {
        "href": "https://example.com/wp-json/wp/v2/users/1",
        "embeddable": true
      }
    ]
  },
  "_embedded": {
    "author": {
      "id": 1,
      "name": "admin",
      "description": "Site administrator"
    }
  }
}
```

--------------------------------

### Create and edit a post with categories

Source: https://github.com/wp-api/docs/blob/master/using-the-rest-api/backbone-javascript-client.md

Shows how to create a new post, load an existing post, fetch related data (categories, author, featured image), set categories, and manage category associations. Requires being logged in. Demonstrates using promises and Backbone collections.

```javascript
// Create a new post
var post = new wp.api.models.Post( { title: 'This is a test post' } );
post.save();

// Load an existing post
var post = new wp.api.models.Post( { id: 1 } );
post.fetch();

// Get a collection of the post's categories (returns a promise)
// Uses _embedded data if available, in which case promise resolves immediately.
post.getCategories().done( function( postCategories ) {
  // ... do something with the categories.
  // The new post has an single Category: Uncategorized
  console.log( postCategories[0].name );
  // response -> "Uncategorized"
} );

// Get a posts author User model.
post.getAuthorUser().done( function( user ){
  // ... do something with user
  console.log( user.get( "name" ) );
} );

// Get a posts featured image Media model.
post.getFeaturedMedia().done( function( image ){
  // ... do something with image
  console.log( image );
} );

// Set the post categories.
post.setCategories( [ "apples", "oranges" ] );

// Get all the categories
var allCategories = new wp.api.collections.Categories()
allCategories.fetch();

var appleCategory = allCategories.findWhere( { slug: "apples" } );

// Add the category to the postCategories collection we previously fetched.
appleCategory.set( "parent_post", post.get( "id" ) );

// Use the POST method so Backbone will not PUT it even though it has an id.
postCategories.create( appleCategory.toJSON(), { type: "POST" } );

// Remove the Uncategorized category
postCategories.at( 0 ).destroy();

// Check the results - re-fetch
postCategories = post.getCategories();

postCategories.at( 0 ).get( "name" );
// response -> "apples"
```

--------------------------------

### Retrieve a Widget - GET /wp/v2/widgets

Source: https://github.com/wp-api/docs/blob/master/reference/widgets.md

Query this endpoint to retrieve a specific widget record. The example uses curl to make a GET request to the WordPress REST API.

```bash
$ curl https://example.com/wp-json/wp/v2/widgets
```

--------------------------------

### Retrieve a Theme - GET /wp/v2/themes

Source: https://github.com/wp-api/docs/blob/master/reference/themes.md

Query this endpoint to retrieve a specific theme record. The example request uses curl to send a GET request to the WordPress REST API.

```http
GET /wp/v2/themes
```

```bash
$ curl https://example.com/wp-json/wp/v2/themes
```

--------------------------------

### List Editor Blocks with curl

Source: https://github.com/wp-api/docs/blob/master/reference/blocks.md

Example request to list Editor Blocks using curl. Replace the example.com domain with your site's URL.

```bash
$ curl https://example.com/wp-json/wp/v2/blocks
```

--------------------------------

### Basic Auth with cURL

Source: https://github.com/wp-api/docs/blob/master/using-the-rest-api/authentication.md

Command-line example using Basic Auth with Application Passwords. Replace USERNAME, PASSWORD, and HOSTNAME with your values. Requires HTTPS.

```bash
curl --user "USERNAME:PASSWORD" https://HOSTNAME/wp-json/wp/v2/users?context=edit
```

--------------------------------

### Create a Nav_Menu (POST /wp/v2/menus)

Source: https://github.com/wp-api/docs/blob/master/reference/nav_menus.md

Endpoint definition for creating a new navigation menu. The request requires a 'name' argument, and supports optional arguments like description, slug, meta, locations, and auto_add.

```http
POST /wp/v2/menus
```

--------------------------------

### Retrieve a Sidebar: GET /wp/v2/sidebars/<id>

Source: https://github.com/wp-api/docs/blob/master/reference/sidebars.md

Retrieve a specific sidebar record. The GET endpoint returns the sidebar with the given id, and the curl command sends a request to the example URL.

```http
GET /wp/v2/sidebars/<id>
```

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

--------------------------------

### List Posts with curl

Source: https://github.com/wp-api/docs/blob/master/reference/posts.md

Example request to list posts using curl.

```bash
$ curl https://example.com/wp-json/wp/v2/posts
```

--------------------------------

### Use response_to_data to get embedded data

Source: https://github.com/wp-api/docs/blob/master/frequently-asked-questions.md

To get embedded data from an internal request, manually call WP_REST_Server::response_to_data() with the second parameter set to true. This example shows how to access the _embedded data.

```php
$request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
$response = rest_do_request( $request );
$data = rest_get_server()->response_to_data( $response, true );
var_dump( $data['_embedded'] );
```

--------------------------------

### Retrieve Page Revisions (GET /wp/v2/pages/<id>/autosaves)

Source: https://github.com/wp-api/docs/blob/master/reference/page-revisions.md

Query this endpoint to retrieve a specific page revision record. The endpoint is GET /wp/v2/pages/<id>/autosaves. The example uses curl to make the request.

```http
GET /wp/v2/pages/<id>/autosaves
```

```shell
$ curl https://example.com/wp-json/wp/v2/pages/<id>/autosaves
```

--------------------------------

### POST /wp/v2/plugins

Source: https://github.com/wp-api/docs/blob/master/reference/plugins.md

Creates a new plugin. Requires the plugin slug and optionally sets the initial activation status.

```APIDOC
## POST /wp/v2/plugins

### Description
Creates a new plugin.

### Method
POST

### Endpoint
/wp/v2/plugins

### Parameters
#### Request Body
- **slug** (string) - Required - WordPress.org plugin directory slug.
- **status** (string) - Optional - The plugin activation status. Default: `inactive`. One of: `inactive`, `active`.

### Request Example
```json
{
  "slug": "hello-dolly",
  "status": "active"
}
```

### Response
#### Success Response (201)
- **slug** (string) - The plugin slug.
- **status** (string) - The plugin activation status.

#### Response Example
```json
{
  "slug": "hello-dolly",
  "status": "active"
}
```
```

--------------------------------

### GET /wp/v2/taxonomies

Source: https://github.com/wp-api/docs/blob/master/reference/taxonomies.md

Retrieves a list of all taxonomies available in the WordPress installation. Supports optional context and type query parameters.

```APIDOC
## GET /wp/v2/taxonomies

### Description
Retrieves a list of all taxonomies available in the WordPress installation.

### Method
GET

### Endpoint
/wp/v2/taxonomies

### Parameters
#### Query Parameters
- **context** (string) - Optional - Scope under which the request is made; determines fields present in response. Default: `view`. One of: `view`, `embed`, `edit`.
- **type** (string) - Optional - Limit results to taxonomies associated with a specific post type.

### Request Example
```
$ curl https://example.com/wp-json/wp/v2/taxonomies
```

### Response
#### Success Response (200)
- **taxonomy** (object) - A taxonomy object keyed by its slug.

#### Response Example
```json
{
  "category": {
    "name": "Categories",
    "slug": "category",
    "description": "",
    "types": ["post"],
    "rest_base": "categories",
    "show_cloud": true,
    "hierarchical": true
  }
}
```
```

--------------------------------

### API index namespaces list

Source: https://github.com/wp-api/docs/blob/master/extending-the-rest-api/adding-custom-endpoints.md

Example of the API index response showing the available namespaces on a site. Clients can check this list to detect support for a custom API namespace.

```json
{
  "name": "WordPress Site",
  "description": "Just another WordPress site",
  "url": "http://example.com/",
  "namespaces": [
    "wp/v2",
    "vendor/v1",
    "myplugin/v1",
    "myplugin/v2",
  ]
}
```

--------------------------------

### Retrieve a Media Item: GET /wp/v2/media/<id>

Source: https://github.com/wp-api/docs/blob/master/reference/media.md

Retrieves a specific media item by its ID. The endpoint definition is GET /wp/v2/media/<id>, and the example request uses curl to query the endpoint. The context argument (default 'view') determines which fields are present in the response.

```http
GET /wp/v2/media/<id>
```

```bash
$ curl https://example.com/wp-json/wp/v2/media/<id>
```

--------------------------------

### Example Response with _links

Source: https://github.com/wp-api/docs/blob/master/using-the-rest-api/linking-and-embedding.md

Example response from a single post request to /wp/v2/posts/42, showing the _links property with collection and author relations. The author link includes the embeddable flag set to true.

```json
{
  "id": 42,
  "_links": {
    "collection": [
      {
        "href": "https://example.com/wp-json/wp/v2/posts"
      }
    ],
    "author": [
      {
        "href": "https://example.com/wp-json/wp/v2/users/1",
        "embeddable": true
      }
    ]
  }
}
```

--------------------------------

### Retrieve a User with GET /wp/v2/users/<id>

Source: https://github.com/wp-api/docs/blob/master/reference/users.md

Retrieve a specific user by ID. The endpoint definition is shown first, followed by a curl example request.

```http
GET /wp/v2/users/<id>
```

```bash
$ curl https://example.com/wp-json/wp/v2/users/<id>
```

--------------------------------

### Retrieve a Global_Styles: GET /wp/v2/global-styles/<id>

Source: https://github.com/wp-api/docs/blob/master/reference/wp_global_styles.md

Retrieve a specific global_styles record. The endpoint requires the id argument, which is the ID of a template. The curl example shows how to query the endpoint.

```http
GET /wp/v2/global-styles/<id>
```

```bash
$ curl https://example.com/wp-json/wp/v2/global-styles/<id>
```

--------------------------------

### Register REST routes with path variables and error handling

Source: https://github.com/wp-api/docs/blob/master/extending-the-rest-api/routes-and-endpoints.md

Registers two REST routes under 'my-shop/v1': a collection route '/products' and a single-product route '/products/(?P<id>[\d]+)' with a numeric path variable. The callbacks return mock product data via rest_ensure_response() and handle missing products by returning a WP_Error with a 404 status. The routes are hooked into rest_api_init.

```php
/**
 * This is our callback function to return our products.
 *
 * @param WP_REST_Request $request This function accepts a rest request to process data.
 */
function prefix_get_products( $request ) {
    // In practice this function would fetch the desired data. Here we are just making stuff up.
    $products = array(
        '1' => 'I am product 1',
        '2' => 'I am product 2',
        '3' => 'I am product 3',
    );

    return rest_ensure_response( $products );
}

/**
 * This is our callback function to return a single product.
 *
 * @param WP_REST_Request $request This function accepts a rest request to process data.
 */
function prefix_get_product( $request ) {
    // In practice this function would fetch the desired data. Here we are just making stuff up.
    $products = array(
        '1' => 'I am product 1',
        '2' => 'I am product 2',
        '3' => 'I am product 3',
    );

    // Here we are grabbing the 'id' path variable from the $request object. WP_REST_Request implements ArrayAccess, which allows us to grab properties as though it is an array.
    $id = (string) $request['id'];

    if ( isset( $products[ $id ] ) ) {
        // Grab the product.
        $product = $products[ $id ];

        // Return the product as a response.
        return rest_ensure_response( $product );
    } else {
        // Return a WP_Error because the request product was not found. In this case we return a 404 because the main resource was not found.
        return new WP_Error( 'rest_product_invalid', esc_html__( 'The product does not exist.', 'my-text-domain' ), array( 'status' => 404 ) );
    }

    // If the code somehow executes to here something bad happened return a 500.
    return new WP_Error( 'rest_api_sad', esc_html__( 'Something went horribly wrong.', 'my-text-domain' ), array( 'status' => 500 ) );
}

/**
 * This function is where we register our routes for our example endpoint.
 */
function prefix_register_product_routes() {
    // Here we are registering our route for a collection of products.
    register_rest_route( 'my-shop/v1', '/products', array(
        // By using this constant we ensure that when the WP_REST_Server changes our readable endpoints will work as intended.
        'methods'  => WP_REST_Server::READABLE,
        // Here we register our callback. The callback is fired when this endpoint is matched by the WP_REST_Server class.
        'callback' => 'prefix_get_products',
    ) );
    // Here we are registering our route for single products. The (?P<id>[\d]+) is our path variable for the ID, which, in this example, can only be some form of positive number.
    register_rest_route( 'my-shop/v1', '/products/(?P<id>[\d]+)', array(
        // By using this constant we ensure that when the WP_REST_Server changes our readable endpoints will work as intended.
        'methods'  => WP_REST_Server::READABLE,
        // Here we register our callback. The callback is fired when this endpoint is matched by the WP_REST_Server class.
        'callback' => 'prefix_get_product',
    ) );
}

add_action( 'rest_api_init', 'prefix_register_product_routes' );
```

--------------------------------

### Retrieve a Template Revision with GET /wp/v2/templates/<parent>/revisions/<id>

Source: https://github.com/wp-api/docs/blob/master/reference/wp_template-revisions.md

Retrieves a single template revision by its ID within a parent template. The 'parent' and 'id' arguments are required; 'context' defaults to 'view' and can be 'view', 'embed', or 'edit'. The HTTP method is GET, and the curl command shows a concrete example request.

```http
GET /wp/v2/templates/<parent>/revisions/<id>
```

```bash
$ curl https://example.com/wp-json/wp/v2/templates/<parent>/revisions/<id>
```

--------------------------------

### Retrieve a Navigation: GET /wp/v2/navigation/<id>

Source: https://github.com/wp-api/docs/blob/master/reference/wp_navigations.md

Retrieves a specific navigation record by its ID. The endpoint accepts arguments id, context (default view), and password. The curl command shows an example request.

```http
GET /wp/v2/navigation/<id>
```

```bash
$ curl https://example.com/wp-json/wp/v2/navigation/<id>
```

--------------------------------

### POST /wp/v2/users

Source: https://github.com/wp-api/docs/blob/master/reference/users.md

Creates a new user with the provided arguments.

```APIDOC
## POST /wp/v2/users

### Description
Creates a new user.

### Method
POST

### Endpoint
/wp/v2/users

### Parameters
#### Request Body
- **username** (string) - Required - Login name for the user.
- **name** (string) - Optional - Display name for the user.
- **first_name** (string) - Optional - First name for the user.
- **last_name** (string) - Optional - Last name for the user.
- **email** (string) - Required - The email address for the user.
- **url** (string) - Optional - URL of the user.
- **description** (string) - Optional - Description of the user.
- **locale** (string) - Optional - Locale for the user. One of: ``, `en_US`.
- **nickname** (string) - Optional - The nickname for the user.
- **slug** (string) - Optional - An alphanumeric identifier for the user.
- **roles** (array) - Optional - Roles assigned to the user.
- **password** (string) - Required - Password for the user (never included).
- **meta** (object) - Optional - Meta fields.
```

--------------------------------

### POST /wp/v2/templates

Source: https://github.com/wp-api/docs/blob/master/reference/wp_templates.md

Creates a new template with the provided slug, theme, type, content, title, description, status, and author.

```APIDOC
## POST /wp/v2/templates

### Description
Creates a new template.

### Method
POST

### Endpoint
/wp/v2/templates

### Parameters
#### Request Body
- **slug** (string) - Required - Unique slug identifying the template.
- **theme** (string) - Optional - Theme identifier for the template.
- **type** (string) - Optional - Type of template.
- **content** (string) - Optional - Content of template.
- **title** (string) - Optional - Title of template.
- **description** (string) - Optional - Description of template.
- **status** (string) - Optional - Status of template. Default: `publish`. One of: `publish`, `future`, `draft`, `pending`, `private`.
- **author** (integer) - Optional - The ID for the author of the template.
```

--------------------------------

### Retrieve a Editor Block: GET /wp/v2/blocks/<id>

Source: https://github.com/wp-api/docs/blob/master/reference/blocks.md

Retrieves a specific editor block by its ID. The endpoint accepts id, context (default view), and password arguments. The curl command shows an example request.

```http
GET /wp/v2/blocks/<id>
```

```bash
$ curl https://example.com/wp-json/wp/v2/blocks/<id>
```

--------------------------------

### Example of _envelope parameter response

Source: https://github.com/wp-api/docs/blob/master/using-the-rest-api/global-parameters.md

Shows the normal response to a GET request to wp/v2/users/me and the equivalent enveloped response when the _envelope parameter is added. The enveloped response wraps the original status, headers, and body inside a fake HTTP 200 response.

```http
HTTP/1.1 302 Found
Location: http://example.com/wp-json/wp/v2/users/42

{
  "id": 42,
  ...
}
```

```http
HTTP/1.1 200 OK

{
  "status": 302,
  "headers": {
    "Location": "http://example.com/wp-json/wp/v2/users/42"
  },
  "body": {
    "id": 42
  }
}
```

--------------------------------

### Object schema with properties keyword

Source: https://github.com/wp-api/docs/blob/master/extending-the-rest-api/schema.md

Defines an object schema requiring 'name' as a string and 'color' as a hex-color string. Shows valid and invalid examples.

```php
array(
    'type'       => 'object',
    'properties' => array(
        'name'  => array(
            'type' => 'string',
        ),
        'color' => array(
            'type'   => 'string',
            'format' => 'hex-color',        
        ),
    ),
);
```

```json
{
  "name": "Primary",
  "color": "#ff6d69"
}
```

```json
{
  "name": "Primary",
  "color": "orange"
}
```

--------------------------------

### My_REST_Posts_Controller class definition

Source: https://github.com/wp-api/docs/blob/master/extending-the-rest-api/controller-classes.md

A complete example of a custom REST API controller class. It initializes namespace and resource name, registers routes for collection and single item endpoints, includes permission checks, retrieves posts, and prepares responses. This class is used to handle GET requests for a custom posts resource.

```php
class My_REST_Posts_Controller {

	// Here initialize our namespace and resource name.
	public function __construct() {
		$this->namespace     = '/my-namespace/v1';
		$this->resource_name = 'posts';
	}

	// Register our routes.
	public function register_routes() {
		register_rest_route( $this->namespace, '/' . $this->resource_name, array(
			// Here we register the readable endpoint for collections.
			array(
				'methods'   => 'GET',
				'callback'  => array( $this, 'get_items' ),
				'permission_callback' => array( $this, 'get_items_permissions_check' ),
			),
			// Register our schema callback.
			'schema' => array( $this, 'get_item_schema' ),
		) );
		register_rest_route( $this->namespace, '/' . $this->resource_name . '/(?P<id>[\d]+)', array(
			// Notice how we are registering multiple endpoints the 'schema' equates to an OPTIONS request.
			array(
				'methods'   => 'GET',
				'callback'  => array( $this, 'get_item' ),
				'permission_callback' => array( $this, 'get_item_permissions_check' ),
			),
			// Register our schema callback.
			'schema' => array( $this, 'get_item_schema' ),
		) );
	}

	/**
	 * Check permissions for the posts.
	 *
	 * @param WP_REST_Request $request Current request.
	 */
	public function get_items_permissions_check( $request ) {
		if ( ! current_user_can( 'read' ) ) {
			return new WP_Error( 'rest_forbidden', esc_html__( 'You cannot view the post resource.' ), array( 'status' => $this->authorization_status_code() ) );
		}
		return true;
	}

	/**
	 * Grabs the five most recent posts and outputs them as a rest response.
	 *
	 * @param WP_REST_Request $request Current request.
	 */
	public function get_items( $request ) {
		$args = array(
			'post_per_page' => 5,
		);
		$posts = get_posts( $args );

		$data = array();

		if ( empty( $posts ) ) {
			return rest_ensure_response( $data );
		}

		foreach ( $posts as $post ) {
			$response = $this->prepare_item_for_response( $post, $request );
			$data[] = $this->prepare_response_for_collection( $response );
		}

		// Return all of our comment response data.
		return rest_ensure_response( $data );
	}

	/**
	 * Check permissions for the posts.
	 *
	 * @param WP_REST_Request $request Current request.
	 */
	public function get_item_permissions_check( $request ) {
		if ( ! current_user_can( 'read' ) ) {
			return new WP_Error( 'rest_forbidden', esc_html__( 'You cannot view the post resource.' ), array( 'status' => $this->authorization_status_code() ) );
		}
		return true;
	}

	/**
	 * Gets post data of requested post id and outputs it as a rest response.
	 *
	 * @param WP_REST_Request $request Current request.
	 */
	public function get_item( $request ) {
		$id = (int) $request['id'];
		$post = get_post( $id );

		if ( empty( $post ) ) {
			return rest_ensure_response( array() );
		}

		$response = $this->prepare_item_for_response( $post, $request );

		// Return all of our post response data.
		return $response;
	}

	/**
	 * Matches the post data to the schema we want.
	 *
	 * @param WP_Post $post The comment object whose response is being prepared.
	 */
	public function prepare_item_for_response( $post, $request ) {
		$post_data = array();

		$schema = $this->get_item_schema( $request );

		// We are also renaming the fields to more understandable names.
		if ( isset( $schema['properties']['id'] ) ) {
			$post_data['id'] = (int) $post->ID;
		}

		if ( isset( $schema['properties']['content'] ) ) {
			$post_data['content'] = apply_filters( 'the_content', $post->post_content, $post );
		}

		return rest_ensure_response( $post_data );
	}

	/**
	 * Prepare a response for inserting into a collection of responses.
	 *
	 * This is copied from WP_REST_Controller class in the WP REST API v2 plugin.
	 *
	 * @param WP_REST_Response $response Response object.
	 * @return array Response data, ready for insertion into collection data.
	 */
	public function prepare_response_for_collection( $response ) {
		if ( ! ( $response instanceof WP_REST_Response ) ) {
			return $response;
		}

		$data = (array) $response->get_data();
		$server = rest_get_server();

		if ( method_exists( $server, 'get_compact_response_links' ) ) {
			$links = call_user_func( array( $server, 'get_compact_response_links' ), $response );
		} else {
			$links = call_user_func( array( $server, 'get_response_links' ), $response );
		}

		if ( ! empty( $links ) ) {
			$data['_links'] = $links;
		}

		return $data;
	}
```

--------------------------------

### Example of _jsonp parameter usage

Source: https://github.com/wp-api/docs/blob/master/using-the-rest-api/global-parameters.md

Demonstrates using the _jsonp parameter to load a JSONP response via a script tag. The callback function receiveData is defined and then referenced in the script src URL.

```html
<script>
function receiveData( data ) {
  // Do something with the data here.
  // For demonstration purposes, we'll simply log it.
  console.log( data );
}
</script>
<script src="https://example.com/wp-json/?_jsonp=receiveData"></script>
```
Tokens:
Raw