Block Patterns

This route returns registered block patterns with their markup, categories, and metadata.

Available routes (endpoints are described below):

/wp/v2/block-patterns/patterns

Controller classes:

Resource schema

The schema lists fields returned by the resource. Fields depend on the context and user capabilities.

Field Context Description
name view, edit Resource field.
title view, edit Resource field.
description view, edit Resource field.
categories view, edit Resource field.
keywords view, edit Resource field.
content view, edit Resource field.
viewport_width view, edit Resource field.

/wp/v2/block-patterns/patterns

An OPTIONS request returns methods, parameters, and the complete schema for the selected route.

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

Get data

Request type

GET /wp/v2/block-patterns/patterns

Request parameters

$context(string)
Response context: view, embed, or edit.
$page(integer)
Collection page number.
$per_page(integer)
Number of items per page.

Request example

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