Block Types
Edit
Topics
Schema
The schema defines all the fields that exist within a block type 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.
api_version integer |
Version of block API.
Read only Context: |
title string |
Title of block type.
Read only Context: |
name string |
Unique name identifying the block type.
Read only Context: |
description string |
Description of block type.
Read only Context: |
icon string or null |
Icon of block type.
Read only Context: |
attributes object or null |
Block attributes.
Read only Context: |
provides_context object |
Context provided by blocks of this type.
Read only Context: |
uses_context array |
Context values inherited by blocks of this type.
Read only Context: |
supports object |
Block supports.
Read only Context: |
category string or null |
Block category.
Read only Context: |
is_dynamic boolean |
Is the block dynamically rendered.
Read only Context: |
editor_script string or null |
Editor script handle.
Read only Context: |
script string or null |
Public facing script handle.
Read only Context: |
editor_style string or null |
Editor style handle.
Read only Context: |
style string or null |
Public facing style handle.
Read only Context: |
styles array |
Block style variations.
Read only Context: |
textdomain string or null |
Public text domain.
Read only Context: |
parent array or null |
Parent blocks.
Read only Context: |
keywords array |
Block keywords.
Read only Context: |
example object or null |
Block example.
Read only Context: |
Retrieve a Block Type
Definition & Example Request
GET /wp/v2/block-types
Query this endpoint to retrieve a specific block type record.
$ curl https://example.com/wp-json/wp/v2/block-types
Retrieve a Block Type
Definition & Example Request
GET /wp/v2/block-types/<namespace>
Query this endpoint to retrieve a specific block type record.
$ curl https://example.com/wp-json/wp/v2/block-types/<namespace>
Retrieve a Block Type
Definition & Example Request
GET /wp/v2/block-types/<namespace>/<name>
Query this endpoint to retrieve a specific block type record.
$ curl https://example.com/wp-json/wp/v2/block-types/<namespace>/<name>