WP_REST_Controller::get_collection_params() public WP 4.7.0
Retrieves the query params for the collections.
{} It's a method of the class: WP_REST_Controller{}
No Hooks.
Return
Array. Query parameters for the collection.
Usage
$WP_REST_Controller = new WP_REST_Controller(); $WP_REST_Controller->get_collection_params();
Changelog
Since 4.7.0 | Introduced. |
Code of WP_REST_Controller::get_collection_params() WP REST Controller::get collection params WP 5.6
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',
),
);
}