WP_REST_Block_Directory_Controller::get_collection_params │ public │ WP 5.5.0

Retrieves the search params for the blocks collection.

Method of the class: WP_REST_Block_Directory_Controller{}

Returns

Array. Collection parameters.

Usage

$WP_REST_Block_Directory_Controller = new WP_REST_Block_Directory_Controller();
$WP_REST_Block_Directory_Controller->get_collection_params();

Changelog

WP_REST_Block_Directory_Controller::get_collection_params() WP REST Block Directory Controller::get collection params code ^{WP 7.0}

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 );
}