WP_REST_Block_Directory_Controller::get_collection_params(): array

In this article

Retrieves the search params for the blocks collection.

Return

array Collection parameters.

Source

public function get_collection_params() {
	$query_params = parent::get_collection_params();

	$query_params['context']['default'] = 'view';

	$query_params['term'] = array(
		'description' => __( 'Limit result set to blocks matching the search term.' ),
		'type'        => 'string',
		'required'    => true,
		'minLength'   => 1,
	);

	unset( $query_params['search'] );

	/**
	 * Filters REST API collection parameters for the block directory controller.
	 *
	 * @since 5.5.0
	 *
	 * @param array $query_params JSON Schema-formatted collection parameters.
	 */
	return apply_filters( 'rest_block_directory_collection_params', $query_params );
}

Hooks

apply_filters( ‘rest_block_directory_collection_params’, array $query_params )

Filters REST API collection parameters for the block directory controller.

Changelog

VersionDescription
5.5.0Introduced.

User Contributed Notes

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