Browse: Home / REST API Handbook / Reference / Block Directory Items

Block Directory Items Edit

Topics

Schema 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.

name

string 		The block name, in namespace/block-name format.

Context: view
title

string 		The block title, in human readable format.

Context: view
description

string 		A short description of the block, in human readable format.

Context: view
id

string 		The block slug.

Context: view
rating

integer 		The star rating of the block.

Context: view
rating_count

integer 		The number of ratings.

Context: view
active_installs

string 		The number sites that have activated this block.

Context: view
author_block_rating

integer 		The average rating of blocks published by the same author.

Context: view
author_block_count

integer 		The number of blocks published by the same author.

Context: view
author

string 		The WordPress.org username of the block author.

Context: view
icon

string,
uri
 		The block icon.

Context: view
last_updated

string,
datetime (details)
 		The date when the block was last updated, in fuzzy human readable format.

Context: view
humanized_updated

string 		The date when the block was last updated, in fuzzy human readable format.

Context: view

Top ↑

List Block Directory Items 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 Definition

GET /wp/v2/block-directory/search

Top ↑

Example Request Example Request

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

Top ↑

Arguments Arguments

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

Default: view

One of: view

page Current page of the collection.

Default: 1

per_page Maximum number of items to be returned in result set.

Default: 10

term Limit result set to blocks matching the search term.

Required: 1