Automattic\WooCommerce\Admin\API

ProductsLowInStock::get_low_in_stock_count_params │ public │ WC 1.0

Get the query params for collections for /count-low-in-stock endpoint.

Method of the class: ProductsLowInStock{}

No Hooks.

Returns

Array.

Usage

$ProductsLowInStock = new ProductsLowInStock();
$ProductsLowInStock->get_low_in_stock_count_params();

ProductsLowInStock::get_low_in_stock_count_params() ProductsLowInStock::get low in stock count params code ^{WC 10.6.2}

public function get_low_in_stock_count_params() {
	$params                       = array();
	$params['context']            = $this->get_context_param();
	$params['context']['default'] = 'view';
	$params['status']             = array(
		'default'           => 'publish',
		'description'       => __( 'Limit result set to products assigned a specific status.', 'woocommerce' ),
		'type'              => 'string',
		'enum'              => array_merge( array_keys( get_post_statuses() ), array( ProductStatus::FUTURE ) ),
		'sanitize_callback' => 'sanitize_key',
		'validate_callback' => 'rest_validate_request_arg',
	);

	return $params;
}