Automattic\WooCommerce\Admin\API

Leaderboards::get_collection_params() │ public │ WC 1.0

Get the query params for collections.

Метод класса: Leaderboards{}

Хуков нет.

Возвращает

Массив.

Использование

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

Код Leaderboards::get_collection_params() Leaderboards::get collection params ^{WC 8.7.0}

public function get_collection_params() {
	$params                    = array();
	$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'           => 5,
		'minimum'           => 1,
		'maximum'           => 20,
		'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['persisted_query'] = array(
		'description'       => __( 'URL query to persist across links.', 'woocommerce' ),
		'type'              => 'string',
		'validate_callback' => 'rest_validate_request_arg',
	);
	return $params;
}