WC_REST_Customers_V1_Controller::get_collection_params │ public │ WC 1.0

Get the query params for collections.

Method of the class: WC_REST_Customers_V1_Controller{}

No Hooks.

Returns

Array.

Usage

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

WC_REST_Customers_V1_Controller::get_collection_params() WC REST Customers V1 Controller::get collection params code ^{WC 10.4.3}

public function get_collection_params() {
	$params = parent::get_collection_params();

	$params['context']['default'] = 'view';

	$params['exclude'] = array(
		'description'       => __( 'Ensure result set excludes specific IDs.', 'woocommerce' ),
		'type'              => 'array',
		'items'             => array(
			'type'          => 'integer',
		),
		'default'           => array(),
		'sanitize_callback' => 'wp_parse_id_list',
	);
	$params['include'] = array(
		'description'       => __( 'Limit result set to specific IDs.', 'woocommerce' ),
		'type'              => 'array',
		'items'             => array(
			'type'          => 'integer',
		),
		'default'           => array(),
		'sanitize_callback' => 'wp_parse_id_list',
	);
	$params['offset'] = array(
		'description'        => __( 'Offset the result set by a specific number of items.', 'woocommerce' ),
		'type'               => 'integer',
		'sanitize_callback'  => 'absint',
		'validate_callback'  => 'rest_validate_request_arg',
	);
	$params['order'] = array(
		'default'            => 'asc',
		'description'        => __( 'Order sort attribute ascending or descending.', 'woocommerce' ),
		'enum'               => array( 'asc', 'desc' ),
		'sanitize_callback'  => 'sanitize_key',
		'type'               => 'string',
		'validate_callback'  => 'rest_validate_request_arg',
	);
	$params['orderby'] = array(
		'default'            => 'name',
		'description'        => __( 'Sort collection by object attribute.', 'woocommerce' ),
		'enum'               => array(
			'id',
			'include',
			'name',
			'registered_date',
		),
		'sanitize_callback'  => 'sanitize_key',
		'type'               => 'string',
		'validate_callback'  => 'rest_validate_request_arg',
	);
	$params['email'] = array(
		'description'        => __( 'Limit result set to resources with a specific email.', 'woocommerce' ),
		'type'               => 'string',
		'format'             => 'email',
		'validate_callback'  => 'rest_validate_request_arg',
	);
	$params['role'] = array(
		'description'        => __( 'Limit result set to resources with a specific role.', 'woocommerce' ),
		'type'               => 'string',
		'default'            => 'customer',
		'enum'               => array_merge( array( 'all' ), $this->get_role_names() ),
		'validate_callback'  => 'rest_validate_request_arg',
	);
	return $params;
}