wp_blocks Edit

Schema Schema

The schema defines all the fields that exist for a wp_block object.

date

string,
datetime ([details](https://core.trac.wordpress.org/ticket/41032))
The date the object was published, in the site's timezone.

Context: view, edit, embed

date_gmt

string,
datetime ([details](https://core.trac.wordpress.org/ticket/41032))
The date the object was published, as GMT.

Context: view, edit

guid

object
The globally unique identifier for the object.

Read only

Context: view, edit

id

integer
Unique identifier for the object.

Read only

Context: view, edit, embed

modified

string,
datetime ([details](https://core.trac.wordpress.org/ticket/41032))
The date the object was last modified, in the site's timezone.

Read only

Context: view, edit

modified_gmt

string,
datetime ([details](https://core.trac.wordpress.org/ticket/41032))
The date the object was last modified, as GMT.

Read only

Context: view, edit

slug

string
An alphanumeric identifier for the object unique to its type.

Context: view, edit, embed

status

string
A named status for the object.

Context: view, edit

One of: publish, future, draft, pending, private

type

string
Type of Post for the object.

Read only

Context: view, edit, embed

password

string
A password to protect access to the content and excerpt.

Context: edit

title

object
The title for the object.

Context: view, edit, embed

content

object
The content for the object.

Context: view, edit

template

string
The theme file to use to display the object.

Context: view, edit

Example Request Example Request

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

Top ↑

List wp_blocks List wp_blocks

Top ↑

Arguments Arguments

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

Default: view

One of: view, embed, edit

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.
after Limit response to posts published after a given ISO8601 compliant date.
before Limit response to posts published before a given ISO8601 compliant date.
exclude Ensure result set excludes specific IDs.
include Limit result set to specific IDs.
offset Offset the result set by a specific number of items.
order Order sort attribute ascending or descending.

Default: desc

One of: asc, desc

orderby Sort collection by object attribute.

Default: date

One of: author, date, id, include, modified, parent, relevance, slug, include_slugs, title

slug Limit result set to posts with one or more specific slugs.
status Limit result set to posts assigned one or more statuses.

Default: publish

Top ↑

Definition Definition

GET /wp/v2/blocks

Top ↑

Example Request Example Request

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

Top ↑

Create a wp_block Create a wp_block

Top ↑

Arguments Arguments

date The date the object was published, in the site's timezone.
date_gmt The date the object was published, as GMT.
slug An alphanumeric identifier for the object unique to its type.
status A named status for the object.
One of: publish, future, draft, pending, private
password A password to protect access to the content and excerpt.
title The title for the object.
content The content for the object.
template The theme file to use to display the object.

Top ↑

Definition Definition

POST /wp/v2/blocks

Top ↑

Retrieve a wp_block Retrieve a wp_block

Top ↑

Arguments Arguments

id Unique identifier for the object.
context Scope under which the request is made; determines fields present in response.

Default: view

One of: view, embed, edit

password The password for the post if it is password protected.

Top ↑

Definition Definition

GET /wp/v2/blocks/<id>

Top ↑

Example Request Example Request

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

Top ↑

Update a wp_block Update a wp_block

Top ↑

Arguments Arguments

id Unique identifier for the object.
date The date the object was published, in the site's timezone.
date_gmt The date the object was published, as GMT.
slug An alphanumeric identifier for the object unique to its type.
status A named status for the object.
One of: publish, future, draft, pending, private
password A password to protect access to the content and excerpt.
title The title for the object.
content The content for the object.
template The theme file to use to display the object.

Top ↑

Definition Definition

POST /wp/v2/blocks/<id>

Top ↑

Example Request Example Request

Top ↑

Delete a wp_block Delete a wp_block

Top ↑

Arguments Arguments

id Unique identifier for the object.
force Whether to bypass trash and force deletion.

Top ↑

Definition Definition

DELETE /wp/v2/blocks/<id>

Top ↑

Example Request Example Request

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