WC_REST_Products_Controller::get_suggested_products_collection_params() │ public │ WC 1.0

Add new options for the suggested-products endpoint.

Method of the class: WC_REST_Products_Controller{}

No Hooks.

Return

Array.

Usage

$WC_REST_Products_Controller = new WC_REST_Products_Controller();
$WC_REST_Products_Controller->get_suggested_products_collection_params();

WC_REST_Products_Controller::get_suggested_products_collection_params() WC REST Products Controller::get suggested products collection params code ^{WC 9.5.1}

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

	$params['categories'] = array(
		'description'       => __( 'Limit result set to specific product categorie ids.', 'woocommerce' ),
		'type'              => 'array',
		'items'             => array(
			'type' => 'integer',
		),
		'default'           => array(),
		'sanitize_callback' => 'wp_parse_id_list',
		'validate_callback' => 'rest_validate_request_arg',
	);

	$params['tags'] = array(
		'description'       => __( 'Limit result set to specific product tag ids.', 'woocommerce' ),
		'type'              => 'array',
		'items'             => array(
			'type' => 'integer',
		),
		'default'           => array(),
		'validate_callback' => 'rest_validate_request_arg',
		'sanitize_callback' => 'wp_parse_id_list',
	);

	$params['limit'] = array(
		'description'       => __( 'Limit result set to specific amount of suggested products.', 'woocommerce' ),
		'type'              => 'integer',
		'default'           => 5,
		'validate_callback' => 'rest_validate_request_arg',
		'sanitize_callback' => 'absint',
	);

	return $params;
}