Block Patterns Edit

Schema

The schema defines all the fields that exist within a block pattern record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.

name

string
The pattern name.

Read only

Context: view, edit, embed

title

string
The pattern title, in human readable format.

Read only

Context: view, edit, embed

content

string
The pattern content.

Read only

Context: view, edit, embed

description

string
The pattern detailed description.

Read only

Context: view, edit, embed

viewport_width

number
The pattern viewport width for inserter preview.

Read only

Context: view, edit, embed

inserter

boolean
Determines whether the pattern is visible in inserter.

Read only

Context: view, edit, embed

categories

array
The pattern category slugs.

Read only

Context: view, edit, embed

keywords

array
The pattern keywords.

Read only

Context: view, edit, embed

block_types

array
Block types that the pattern is intended to be used with.

Read only

Context: view, edit, embed

post_types

array
An array of post types that the pattern is restricted to be used with.

Read only

Context: view, edit, embed

template_types

array
An array of template types where the pattern fits.

Read only

Context: view, edit, embed

Top ↑

Retrieve a Block Pattern

Top ↑

Definition & Example Request

GET /wp/v2/block-patterns/patterns

Query this endpoint to retrieve a specific block pattern record.

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

There are no arguments for this endpoint.