Block Directory Items 
Edit
Schema
The schema defines all the fields that exist within a block directory item 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.
namestring |
The block name, in namespace/block-name format.
Context: |
titlestring |
The block title, in human readable format.
Context: |
descriptionstring |
A short description of the block, in human readable format.
Context: |
idstring |
The block slug.
Context: |
ratinginteger |
The star rating of the block.
Context: |
rating_countinteger |
The number of ratings.
Context: |
active_installsstring |
The number sites that have activated this block.
Context: |
author_block_ratinginteger |
The average rating of blocks published by the same author.
Context: |
author_block_countinteger |
The number of blocks published by the same author.
Context: |
authorstring |
The WordPress.org username of the block author.
Context: |
iconstring, uri |
The block icon.
Context: |
last_updatedstring, datetime (details) |
The date when the block was last updated, in fuzzy human readable format.
Context: |
humanized_updatedstring |
The date when the block was last updated, in fuzzy human readable format.
Context: |
List Block Directory Items
Query this endpoint to retrieve a collection of block directory items. The response you receive can be controlled and filtered using the URL query parameters below.
Definition
GET /wp/v2/block-directory/search
Example Request
$ curl https://example.com/wp-json/wp/v2/block-directory/search
Arguments
context
|
Scope under which the request is made; determines fields present in response.
Default: One of: |
page
|
Current page of the collection.
Default: |
per_page
|
Maximum number of items to be returned in result set.
Default: |
term
|
Limit result set to blocks matching the search term.
Required: 1 |