Automattic\WooCommerce\Internal\RestApi\Routes\V4\Products
Controller::get_suggested_products_collection_params
Add new options for the suggested-products endpoint.
Method of the class: Controller{}
No Hooks.
Returns
Array.
Usage
$Controller = new Controller(); $Controller->get_suggested_products_collection_params();
Controller::get_suggested_products_collection_params() Controller::get suggested products collection params code WC 10.4.3
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;
}