WP_REST_Pattern_Directory_Controller::get_collection_params() WordPress Method
The WP_REST_Pattern_Directory_Controller::get_collection_params() method is used to get the collection parameters for the REST API. This includes the default values for the various parameters, as well as the allowed values for the various parameters.
WP_REST_Pattern_Directory_Controller::get_collection_params() #
Retrieves the search parameters for the block pattern’s collection.
Return
(array) Collection parameters.
Source
File: wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php
public function get_collection_params() { $query_params = parent::get_collection_params(); // Pagination is not supported. unset( $query_params['page'] ); unset( $query_params['per_page'] ); $query_params['search']['minLength'] = 1; $query_params['context']['default'] = 'view'; $query_params['category'] = array( 'description' => __( 'Limit results to those matching a category ID.' ), 'type' => 'integer', 'minimum' => 1, ); $query_params['keyword'] = array( 'description' => __( 'Limit results to those matching a keyword ID.' ), 'type' => 'integer', 'minimum' => 1, ); $query_params['slug'] = array( 'description' => __( 'Limit results to those matching a pattern (slug).' ), 'type' => 'array', ); /** * Filter collection parameters for the block pattern directory controller. * * @since 5.8.0 * * @param array $query_params JSON Schema-formatted collection parameters. */ return apply_filters( 'rest_pattern_directory_collection_params', $query_params ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
5.8.0 | Introduced. |