WP_REST_Controller::get_collection_params() WordPress Method
The WP_REST_Controller::get_collection_params() method is used to retrieve the query parameters for collections of items. This is useful for exposing filters and other data to clients that want to request a specific subset of items from a collection.
WP_REST_Controller::get_collection_params() #
Retrieves the query params for the collections.
Return
(array) Query parameters for the collection.
Source
File: wp-includes/rest-api/endpoints/class-wp-rest-controller.php
public function get_collection_params() { return array( 'context' => $this->get_context_param(), 'page' => array( 'description' => __( 'Current page of the collection.' ), 'type' => 'integer', 'default' => 1, 'sanitize_callback' => 'absint', 'validate_callback' => 'rest_validate_request_arg', 'minimum' => 1, ), 'per_page' => array( 'description' => __( 'Maximum number of items to be returned in result set.' ), 'type' => 'integer', 'default' => 10, 'minimum' => 1, 'maximum' => 100, 'sanitize_callback' => 'absint', 'validate_callback' => 'rest_validate_request_arg', ), 'search' => array( 'description' => __( 'Limit results to those matching a string.' ), 'type' => 'string', 'sanitize_callback' => 'sanitize_text_field', 'validate_callback' => 'rest_validate_request_arg', ), ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
4.7.0 | Introduced. |