WP_REST_Controller::get_collection_params PHP Method

get_collection_params() public method

Get the query params for collections.
public get_collection_params ( ) : array
return array
    public function get_collection_params()
    {
        return array('context' => $this->get_context_param(), 'page' => array('description' => __('Current page of the collection.', 'woocommerce'), '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.', 'woocommerce'), '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.', 'woocommerce'), 'type' => 'string', 'sanitize_callback' => 'sanitize_text_field', 'validate_callback' => 'rest_validate_request_arg'));
    }

Usage Example

 /**
  * Get the query params for collections
  *
  * @return array
  */
 public function get_collection_params()
 {
     $params = parent::get_collection_params();
     $new_params = array();
     $new_params['context'] = $params['context'];
     $new_params['context']['default'] = 'edit';
     return $new_params;
 }
All Usage Examples Of WP_REST_Controller::get_collection_params