WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Block_Types_Controller::get_item()

WP_REST_Block_Types_Controller::get_item( WP_REST_Request $request ): WP_REST_Response|WP_Error

In this article

Back to top

Retrieves a specific block type.

Parameters

$requestWP_REST_Requestrequired
Full details about the request.

Return

WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.

Source

public function get_item( $request ) {
	$block_name = sprintf( '%s/%s', $request['namespace'], $request['name'] );
	$block_type = $this->get_block( $block_name );
	if ( is_wp_error( $block_type ) ) {
		return $block_type;
	}
	$data = $this->prepare_item_for_response( $block_type, $request );

	return rest_ensure_response( $data );
}

View all references View on Trac View on GitHub

UsesDescription
WP_REST_Block_Types_Controller::get_block()wp-includes/rest-api/endpoints/class-wp-rest-block-types-controller.php

Get the block, if the name is valid.

WP_REST_Block_Types_Controller::prepare_item_for_response()wp-includes/rest-api/endpoints/class-wp-rest-block-types-controller.php

Prepares a block type object for serialization.

rest_ensure_response()wp-includes/rest-api.php

Ensures a REST response is a response object (for consistency).

is_wp_error()wp-includes/load.php

Checks whether the given variable is a WordPress Error.

Show 2 moreShow less

Changelog

VersionDescription
5.5.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.