WP_REST_Templates_Controller::get_collection_params()publicWP 5.8.0

Retrieves the query params for the posts collection.

{} It's a method of the class: WP_REST_Templates_Controller{}

No Hooks.

Return

Array. Collection parameters.

Usage

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

Changelog

Since 5.8.0 Introduced.
Since 5.9.0 Added 'area' and 'post_type'.

Code of WP_REST_Templates_Controller::get_collection_params() WP 6.0

public function get_collection_params() {
	return array(
		'context'   => $this->get_context_param( array( 'default' => 'view' ) ),
		'wp_id'     => array(
			'description' => __( 'Limit to the specified post id.' ),
			'type'        => 'integer',
		),
		'area'      => array(
			'description' => __( 'Limit to the specified template part area.' ),
			'type'        => 'string',
		),
		'post_type' => array(
			'description' => __( 'Post type to get the templates for.' ),
			'type'        => 'string',
		),
	);
}