Automattic\WooCommerce\Admin\API\Reports

GenericController::get_collection_params │ public │ WC 1.0

Get the query params definition for collections.

Method of the class: GenericController{}

No Hooks.

Returns

Array.

Usage

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

GenericController::get_collection_params() GenericController::get collection params code ^{WC 10.5.0}

public function get_collection_params() {
	$params                        = array();
	$params['context']             = $this->get_context_param( array( 'default' => 'view' ) );
	$params['page']                = array(
		'description'       => __( 'Current page of the collection.', 'woocommerce' ),
		'type'              => 'integer',
		'default'           => 1,
		'sanitize_callback' => 'absint',
		'validate_callback' => 'rest_validate_request_arg',
		'minimum'           => 1,
	);
	$params['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',
	);
	$params['after']               = array(
		'description'       => __( 'Limit response to resources published after a given ISO8601 compliant date.', 'woocommerce' ),
		'type'              => 'string',
		'format'            => 'date-time',
		'validate_callback' => 'rest_validate_request_arg',
	);
	$params['before']              = array(
		'description'       => __( 'Limit response to resources published before a given ISO8601 compliant date.', 'woocommerce' ),
		'type'              => 'string',
		'format'            => 'date-time',
		'validate_callback' => 'rest_validate_request_arg',
	);
	$params['order']               = array(
		'description'       => __( 'Order sort attribute ascending or descending.', 'woocommerce' ),
		'type'              => 'string',
		'default'           => 'desc',
		'enum'              => array( 'asc', 'desc' ),
		'validate_callback' => 'rest_validate_request_arg',
	);
	$params['orderby']             = array(
		'description'       => __( 'Sort collection by object attribute.', 'woocommerce' ),
		'type'              => 'string',
		'default'           => 'date',
		'enum'              => array(
			'date',
		),
		'validate_callback' => 'rest_validate_request_arg',
	);
	$params['force_cache_refresh'] = array(
		'description'       => __( 'Force retrieval of fresh data instead of from the cache.', 'woocommerce' ),
		'type'              => 'boolean',
		'sanitize_callback' => 'wp_validate_boolean',
		'validate_callback' => 'rest_validate_request_arg',
	);

	return $params;
}