woocommerce/includes/api/v1/class-wc-rest-products-cont...

2641 lines
88 KiB
PHP
Raw Normal View History

2017-02-09 20:40:35 +00:00
<?php
/**
* REST API Products controller
*
* Handles requests to the /products endpoint.
*
* @author WooThemes
* @category API
* @package WooCommerce/API
2017-02-13 21:44:27 +00:00
* @since 2.7.0
2017-02-09 20:40:35 +00:00
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* REST API Products controller class.
*
* @package WooCommerce/API
* @extends WC_REST_Posts_Controller
*/
class WC_REST_Products_V1_Controller extends WC_REST_Posts_Controller {
/**
* Endpoint namespace.
*
* @var string
*/
protected $namespace = 'wc/v1';
/**
* Route base.
*
* @var string
*/
protected $rest_base = 'products';
/**
* Post type.
*
* @var string
*/
protected $post_type = 'product';
/**
* Initialize product actions.
*/
public function __construct() {
add_filter( "woocommerce_rest_{$this->post_type}_query", array( $this, 'query_args' ), 10, 2 );
add_action( "woocommerce_rest_insert_{$this->post_type}", array( $this, 'clear_transients' ) );
}
/**
* Register the routes for products.
*/
public function register_routes() {
register_rest_route( $this->namespace, '/' . $this->rest_base, array(
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_items' ),
'permission_callback' => array( $this, 'get_items_permissions_check' ),
'args' => $this->get_collection_params(),
),
array(
'methods' => WP_REST_Server::CREATABLE,
'callback' => array( $this, 'create_item' ),
'permission_callback' => array( $this, 'create_item_permissions_check' ),
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ),
),
'schema' => array( $this, 'get_public_item_schema' ),
) );
register_rest_route( $this->namespace, '/' . $this->rest_base . '/(?P<id>[\d]+)', array(
'args' => array(
'id' => array(
'description' => __( 'Unique identifier for the resource.', 'woocommerce' ),
'type' => 'integer',
),
),
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_item' ),
'permission_callback' => array( $this, 'get_item_permissions_check' ),
'args' => array(
'context' => $this->get_context_param( array( 'default' => 'view' ) ),
),
),
array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => array( $this, 'update_item' ),
'permission_callback' => array( $this, 'update_item_permissions_check' ),
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
),
array(
'methods' => WP_REST_Server::DELETABLE,
'callback' => array( $this, 'delete_item' ),
'permission_callback' => array( $this, 'delete_item_permissions_check' ),
'args' => array(
'force' => array(
'default' => false,
'description' => __( 'Whether to bypass trash and force deletion.', 'woocommerce' ),
'type' => 'boolean',
),
),
),
'schema' => array( $this, 'get_public_item_schema' ),
) );
register_rest_route( $this->namespace, '/' . $this->rest_base . '/batch', array(
array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => array( $this, 'batch_items' ),
'permission_callback' => array( $this, 'batch_items_permissions_check' ),
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
),
'schema' => array( $this, 'get_public_batch_schema' ),
) );
}
/**
* Get post types.
*
* @return array
*/
protected function get_post_types() {
return array( 'product', 'product_variation' );
}
/**
* Query args.
*
2017-02-13 21:44:27 +00:00
* @param array $args Request args.
* @param WP_REST_Request $request Request data.
2017-02-09 20:40:35 +00:00
* @return array
*/
public function query_args( $args, $request ) {
// Set post_status.
$args['post_status'] = $request['status'];
// Taxonomy query to filter products by type, category,
// tag, shipping class, and attribute.
$tax_query = array();
// Map between taxonomy name and arg's key.
$taxonomies = array(
'product_cat' => 'category',
'product_tag' => 'tag',
'product_shipping_class' => 'shipping_class',
);
// Set tax_query for each passed arg.
foreach ( $taxonomies as $taxonomy => $key ) {
if ( ! empty( $request[ $key ] ) ) {
$terms = explode( ',', $request[ $key ] );
$tax_query[] = array(
'taxonomy' => $taxonomy,
'field' => 'term_id',
'terms' => $terms,
);
}
}
// Filter product type by slug.
if ( ! empty( $request['type'] ) ) {
$terms = explode( ',', $request['type'] );
$tax_query[] = array(
'taxonomy' => 'product_type',
'field' => 'slug',
'terms' => $terms,
);
}
// Filter by attribute and term.
if ( ! empty( $request['attribute'] ) && ! empty( $request['attribute_term'] ) ) {
if ( in_array( $request['attribute'], wc_get_attribute_taxonomy_names() ) ) {
$terms = explode( ',', $request['attribute_term'] );
$tax_query[] = array(
'taxonomy' => $request['attribute'],
'field' => 'term_id',
'terms' => $terms,
);
}
}
if ( ! empty( $tax_query ) ) {
$args['tax_query'] = $tax_query;
}
// Filter by sku.
if ( ! empty( $request['sku'] ) ) {
if ( ! empty( $args['meta_query'] ) ) {
$args['meta_query'] = array();
}
$args['meta_query'][] = array(
'key' => '_sku',
'value' => $request['sku'],
2017-02-17 18:10:15 +00:00
'compare' => '=',
2017-02-09 20:40:35 +00:00
);
}
// Apply all WP_Query filters again.
if ( is_array( $request['filter'] ) ) {
$args = array_merge( $args, $request['filter'] );
unset( $args['filter'] );
}
// Force the post_type argument, since it's not a user input variable.
if ( ! empty( $request['sku'] ) ) {
$args['post_type'] = $this->get_post_types();
} else {
$args['post_type'] = $this->post_type;
}
return $args;
}
/**
* Get the downloads for a product or product variation.
*
2017-02-13 21:44:27 +00:00
* @param WC_Product|WC_Product_Variation $product Product instance.
2017-02-09 20:40:35 +00:00
* @return array
*/
protected function get_downloads( $product ) {
$downloads = array();
if ( $product->is_downloadable() ) {
2017-02-13 21:44:27 +00:00
foreach ( $product->get_downloads() as $file_id => $file ) {
2017-02-09 20:40:35 +00:00
$downloads[] = array(
'id' => $file_id, // MD5 hash.
'name' => $file['name'],
'file' => $file['file'],
);
}
}
return $downloads;
}
/**
* Get taxonomy terms.
*
2017-02-13 21:44:27 +00:00
* @param WC_Product $product Product instance.
* @param string $taxonomy Taxonomy slug.
2017-02-09 20:40:35 +00:00
* @return array
*/
protected function get_taxonomy_terms( $product, $taxonomy = 'cat' ) {
$terms = array();
2017-02-13 21:44:27 +00:00
foreach ( wc_get_object_terms( $product->get_id(), 'product_' . $taxonomy ) as $term ) {
2017-02-09 20:40:35 +00:00
$terms[] = array(
'id' => $term->term_id,
'name' => $term->name,
'slug' => $term->slug,
);
}
return $terms;
}
/**
* Get the images for a product or product variation.
*
2017-02-13 21:44:27 +00:00
* @param WC_Product|WC_Product_Variation $product Product instance.
2017-02-09 20:40:35 +00:00
* @return array
*/
protected function get_images( $product ) {
$images = array();
$attachment_ids = array();
2017-02-13 21:44:27 +00:00
// Add featured image.
if ( has_post_thumbnail( $product->get_id() ) ) {
$attachment_ids[] = $product->get_image_id();
2017-02-09 20:40:35 +00:00
}
2017-02-13 21:44:27 +00:00
// Add gallery images.
$attachment_ids = array_merge( $attachment_ids, $product->get_gallery_image_ids() );
2017-02-09 20:40:35 +00:00
// Build image data.
foreach ( $attachment_ids as $position => $attachment_id ) {
$attachment_post = get_post( $attachment_id );
if ( is_null( $attachment_post ) ) {
continue;
}
$attachment = wp_get_attachment_image_src( $attachment_id, 'full' );
if ( ! is_array( $attachment ) ) {
continue;
}
$images[] = array(
'id' => (int) $attachment_id,
'date_created' => wc_rest_prepare_date_response( $attachment_post->post_date_gmt ),
'date_modified' => wc_rest_prepare_date_response( $attachment_post->post_modified_gmt ),
'src' => current( $attachment ),
'name' => get_the_title( $attachment_id ),
'alt' => get_post_meta( $attachment_id, '_wp_attachment_image_alt', true ),
'position' => (int) $position,
);
}
// Set a placeholder image if the product has no images set.
if ( empty( $images ) ) {
$images[] = array(
'id' => 0,
'date_created' => wc_rest_prepare_date_response( current_time( 'mysql' ) ), // Default to now.
'date_modified' => wc_rest_prepare_date_response( current_time( 'mysql' ) ),
'src' => wc_placeholder_img_src(),
'name' => __( 'Placeholder', 'woocommerce' ),
'alt' => __( 'Placeholder', 'woocommerce' ),
'position' => 0,
);
}
return $images;
}
/**
* Get attribute taxonomy label.
*
2017-02-13 21:44:27 +00:00
* @param string $name Taxonomy name.
2017-02-09 20:40:35 +00:00
* @return string
*/
protected function get_attribute_taxonomy_label( $name ) {
$tax = get_taxonomy( $name );
$labels = get_taxonomy_labels( $tax );
return $labels->singular_name;
}
/**
* Get default attributes.
*
2017-02-13 21:44:27 +00:00
* @param WC_Product $product Product instance.
2017-02-09 20:40:35 +00:00
* @return array
*/
protected function get_default_attributes( $product ) {
$default = array();
if ( $product->is_type( 'variable' ) ) {
2017-02-13 21:44:27 +00:00
foreach ( array_filter( (array) $product->get_default_attributes(), 'strlen' ) as $key => $value ) {
2017-02-09 20:40:35 +00:00
if ( 0 === strpos( $key, 'pa_' ) ) {
$default[] = array(
'id' => wc_attribute_taxonomy_id_by_name( $key ),
'name' => $this->get_attribute_taxonomy_label( $key ),
'option' => $value,
);
} else {
$default[] = array(
'id' => 0,
'name' => str_replace( 'pa_', '', $key ),
'option' => $value,
);
}
}
}
return $default;
}
/**
* Get attribute options.
*
2017-02-13 21:44:27 +00:00
* @param int $product_id Product ID.
* @param array $attribute Attribute data.
2017-02-09 20:40:35 +00:00
* @return array
*/
protected function get_attribute_options( $product_id, $attribute ) {
if ( isset( $attribute['is_taxonomy'] ) && $attribute['is_taxonomy'] ) {
return wc_get_product_terms( $product_id, $attribute['name'], array( 'fields' => 'names' ) );
} elseif ( isset( $attribute['value'] ) ) {
return array_map( 'trim', explode( '|', $attribute['value'] ) );
}
return array();
}
/**
* Get the attributes for a product or product variation.
*
2017-02-13 21:44:27 +00:00
* @param WC_Product|WC_Product_Variation $product Product instance.
2017-02-09 20:40:35 +00:00
* @return array
*/
protected function get_attributes( $product ) {
$attributes = array();
if ( $product->is_type( 'variation' ) ) {
// Variation attributes.
foreach ( $product->get_variation_attributes() as $attribute_name => $attribute ) {
$name = str_replace( 'attribute_', '', $attribute_name );
if ( ! $attribute ) {
continue;
}
// Taxonomy-based attributes are prefixed with `pa_`, otherwise simply `attribute_`.
if ( 0 === strpos( $attribute_name, 'attribute_pa_' ) ) {
2017-02-13 21:44:27 +00:00
$option_term = get_term_by( 'slug', $attribute, $name );
2017-02-09 20:40:35 +00:00
$attributes[] = array(
'id' => wc_attribute_taxonomy_id_by_name( $name ),
'name' => $this->get_attribute_taxonomy_label( $name ),
'option' => $option_term && ! is_wp_error( $option_term ) ? $option_term->name : $attribute,
);
} else {
$attributes[] = array(
'id' => 0,
2017-02-13 21:44:27 +00:00
'name' => $name,
2017-02-09 20:40:35 +00:00
'option' => $attribute,
);
}
}
} else {
foreach ( $product->get_attributes() as $attribute ) {
if ( $attribute['is_taxonomy'] ) {
$attributes[] = array(
'id' => wc_attribute_taxonomy_id_by_name( $attribute['name'] ),
'name' => $this->get_attribute_taxonomy_label( $attribute['name'] ),
'position' => (int) $attribute['position'],
'visible' => (bool) $attribute['is_visible'],
'variation' => (bool) $attribute['is_variation'],
2017-02-13 21:44:27 +00:00
'options' => $this->get_attribute_options( $product->get_id(), $attribute ),
2017-02-09 20:40:35 +00:00
);
} else {
$attributes[] = array(
'id' => 0,
2017-02-13 21:44:27 +00:00
'name' => $attribute['name'],
2017-02-09 20:40:35 +00:00
'position' => (int) $attribute['position'],
'visible' => (bool) $attribute['is_visible'],
'variation' => (bool) $attribute['is_variation'],
2017-02-13 21:44:27 +00:00
'options' => $this->get_attribute_options( $product->get_id(), $attribute ),
2017-02-09 20:40:35 +00:00
);
}
}
}
return $attributes;
}
/**
* Get product menu order.
*
2017-02-13 21:44:27 +00:00
* @deprecated 2.7.0
* @param WC_Product $product Product instance.
2017-02-09 20:40:35 +00:00
* @return int
*/
protected function get_product_menu_order( $product ) {
2017-02-13 21:44:27 +00:00
return $product->get_menu_order();
2017-02-09 20:40:35 +00:00
}
/**
* Get product data.
*
2017-02-13 21:44:27 +00:00
* @param WC_Product $product Product instance.
2017-02-09 20:40:35 +00:00
* @return array
*/
protected function get_product_data( $product ) {
$data = array(
2017-02-13 21:44:27 +00:00
'id' => $product->get_id(),
'name' => $product->get_name(),
'slug' => $product->get_slug(),
2017-02-09 20:40:35 +00:00
'permalink' => $product->get_permalink(),
2017-02-13 21:44:27 +00:00
'date_created' => wc_rest_prepare_date_response( $product->get_date_created() ),
'date_modified' => wc_rest_prepare_date_response( $product->get_date_modified() ),
'type' => $product->get_type(),
'status' => $product->get_status(),
2017-02-09 20:40:35 +00:00
'featured' => $product->is_featured(),
2017-02-13 21:44:27 +00:00
'catalog_visibility' => $product->get_catalog_visibility(),
'description' => wpautop( do_shortcode( $product->get_description() ) ),
'short_description' => apply_filters( 'woocommerce_short_description', $product->get_short_description() ),
2017-02-09 20:40:35 +00:00
'sku' => $product->get_sku(),
'price' => $product->get_price(),
'regular_price' => $product->get_regular_price(),
'sale_price' => $product->get_sale_price() ? $product->get_sale_price() : '',
2017-02-13 21:44:27 +00:00
'date_on_sale_from' => $product->get_date_on_sale_from() ? date( 'Y-m-d', $product->get_date_on_sale_from() ) : '',
'date_on_sale_to' => $product->get_date_on_sale_to() ? date( 'Y-m-d', $product->get_date_on_sale_to() ) : '',
2017-02-09 20:40:35 +00:00
'price_html' => $product->get_price_html(),
'on_sale' => $product->is_on_sale(),
'purchasable' => $product->is_purchasable(),
2017-02-13 21:44:27 +00:00
'total_sales' => $product->get_total_sales(),
2017-02-09 20:40:35 +00:00
'virtual' => $product->is_virtual(),
'downloadable' => $product->is_downloadable(),
'downloads' => $this->get_downloads( $product ),
2017-02-13 21:44:27 +00:00
'download_limit' => $product->get_download_limit(),
'download_expiry' => $product->get_download_expiry(),
'download_type' => 'standard',
2017-02-09 20:40:35 +00:00
'external_url' => $product->is_type( 'external' ) ? $product->get_product_url() : '',
'button_text' => $product->is_type( 'external' ) ? $product->get_button_text() : '',
'tax_status' => $product->get_tax_status(),
'tax_class' => $product->get_tax_class(),
'manage_stock' => $product->managing_stock(),
'stock_quantity' => $product->get_stock_quantity(),
'in_stock' => $product->is_in_stock(),
2017-02-13 21:44:27 +00:00
'backorders' => $product->get_backorders(),
2017-02-09 20:40:35 +00:00
'backorders_allowed' => $product->backorders_allowed(),
'backordered' => $product->is_on_backorder(),
'sold_individually' => $product->is_sold_individually(),
'weight' => $product->get_weight(),
'dimensions' => array(
'length' => $product->get_length(),
'width' => $product->get_width(),
'height' => $product->get_height(),
),
'shipping_required' => $product->needs_shipping(),
'shipping_taxable' => $product->is_shipping_taxable(),
'shipping_class' => $product->get_shipping_class(),
2017-02-13 21:44:27 +00:00
'shipping_class_id' => $product->get_shipping_class_id(),
'reviews_allowed' => $product->get_reviews_allowed(),
2017-02-09 20:40:35 +00:00
'average_rating' => wc_format_decimal( $product->get_average_rating(), 2 ),
2017-02-13 21:44:27 +00:00
'rating_count' => $product->get_rating_count(),
'related_ids' => array_map( 'absint', array_values( wc_get_related_products( $product->get_id() ) ) ),
'upsell_ids' => array_map( 'absint', $product->get_upsell_ids() ),
'cross_sell_ids' => array_map( 'absint', $product->get_cross_sell_ids() ),
'parent_id' => $product->get_parent_id(),
'purchase_note' => wpautop( do_shortcode( wp_kses_post( $product->get_purchase_note() ) ) ),
2017-02-09 20:40:35 +00:00
'categories' => $this->get_taxonomy_terms( $product ),
'tags' => $this->get_taxonomy_terms( $product, 'tag' ),
'images' => $this->get_images( $product ),
'attributes' => $this->get_attributes( $product ),
'default_attributes' => $this->get_default_attributes( $product ),
'variations' => array(),
'grouped_products' => array(),
2017-02-13 21:44:27 +00:00
'menu_order' => $product->get_menu_order(),
2017-02-09 20:40:35 +00:00
);
return $data;
}
/**
* Get an individual variation's data.
*
2017-02-13 21:44:27 +00:00
* @param WC_Product $product Product instance.
2017-02-09 20:40:35 +00:00
* @return array
*/
protected function get_variation_data( $product ) {
$variations = array();
foreach ( $product->get_children() as $child_id ) {
2017-02-13 21:44:27 +00:00
$variation = wc_get_product( $child_id );
2017-02-09 20:40:35 +00:00
if ( ! $variation->exists() ) {
continue;
}
$variations[] = array(
2017-02-13 21:44:27 +00:00
'id' => $variation->get_id(),
'date_created' => wc_rest_prepare_date_response( $variation->get_date_created() ),
'date_modified' => wc_rest_prepare_date_response( $variation->get_date_modified() ),
2017-02-09 20:40:35 +00:00
'permalink' => $variation->get_permalink(),
'sku' => $variation->get_sku(),
'price' => $variation->get_price(),
'regular_price' => $variation->get_regular_price(),
'sale_price' => $variation->get_sale_price(),
2017-02-13 21:44:27 +00:00
'date_on_sale_from' => $variation->get_date_on_sale_from() ? date( 'Y-m-d', $variation->get_date_on_sale_from() ) : '',
'date_on_sale_to' => $variation->get_date_on_sale_to() ? date( 'Y-m-d', $variation->get_date_on_sale_to() ) : '',
2017-02-09 20:40:35 +00:00
'on_sale' => $variation->is_on_sale(),
'purchasable' => $variation->is_purchasable(),
'visible' => $variation->is_visible(),
'virtual' => $variation->is_virtual(),
'downloadable' => $variation->is_downloadable(),
'downloads' => $this->get_downloads( $variation ),
2017-02-13 21:44:27 +00:00
'download_limit' => '' !== $variation->get_download_limit() ? (int) $variation->get_download_limit() : -1,
'download_expiry' => '' !== $variation->get_download_expiry() ? (int) $variation->get_download_expiry() : -1,
2017-02-09 20:40:35 +00:00
'tax_status' => $variation->get_tax_status(),
'tax_class' => $variation->get_tax_class(),
'manage_stock' => $variation->managing_stock(),
'stock_quantity' => $variation->get_stock_quantity(),
'in_stock' => $variation->is_in_stock(),
2017-02-13 21:44:27 +00:00
'backorders' => $variation->get_backorders(),
2017-02-09 20:40:35 +00:00
'backorders_allowed' => $variation->backorders_allowed(),
'backordered' => $variation->is_on_backorder(),
'weight' => $variation->get_weight(),
'dimensions' => array(
'length' => $variation->get_length(),
'width' => $variation->get_width(),
'height' => $variation->get_height(),
),
'shipping_class' => $variation->get_shipping_class(),
'shipping_class_id' => $variation->get_shipping_class_id(),
'image' => $this->get_images( $variation ),
'attributes' => $this->get_attributes( $variation ),
);
}
return $variations;
}
/**
* Prepare a single product output for response.
*
2017-02-13 21:44:27 +00:00
* @param WP_Post $post Post object.
2017-02-09 20:40:35 +00:00
* @param WP_REST_Request $request Request object.
2017-02-13 21:44:27 +00:00
* @return WP_REST_Response
2017-02-09 20:40:35 +00:00
*/
public function prepare_item_for_response( $post, $request ) {
$product = wc_get_product( $post );
$data = $this->get_product_data( $product );
// Add variations to variable products.
if ( $product->is_type( 'variable' ) && $product->has_child() ) {
$data['variations'] = $this->get_variation_data( $product );
}
// Add grouped products data.
if ( $product->is_type( 'grouped' ) && $product->has_child() ) {
$data['grouped_products'] = $product->get_children();
}
$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
$data = $this->add_additional_fields_to_object( $data, $request );
$data = $this->filter_response_by_context( $data, $context );
// Wrap the data in a response object.
$response = rest_ensure_response( $data );
$response->add_links( $this->prepare_links( $product, $request ) );
/**
* Filter the data for a response.
*
* The dynamic portion of the hook name, $this->post_type, refers to post_type of the post being
* prepared for the response.
*
* @param WP_REST_Response $response The response object.
* @param WP_Post $post Post object.
* @param WP_REST_Request $request Request object.
*/
return apply_filters( "woocommerce_rest_prepare_{$this->post_type}", $response, $post, $request );
}
/**
* Prepare links for the request.
*
2017-02-13 21:44:27 +00:00
* @param WC_Product $product Product object.
* @param WP_REST_Request $request Request object.
2017-02-09 20:40:35 +00:00
* @return array Links for the given product.
*/
protected function prepare_links( $product, $request ) {
$links = array(
'self' => array(
2017-02-13 21:44:27 +00:00
'href' => rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $product->get_id() ) ),
2017-02-09 20:40:35 +00:00
),
'collection' => array(
'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
),
);
2017-02-13 21:44:27 +00:00
if ( $product->get_parent_id() ) {
2017-02-09 20:40:35 +00:00
$links['up'] = array(
2017-02-13 21:44:27 +00:00
'href' => rest_url( sprintf( '/%s/products/%d', $this->namespace, $product->get_parent_id() ) ),
2017-02-09 20:40:35 +00:00
);
}
return $links;
}
/**
* Prepare a single product for create or update.
*
* @param WP_REST_Request $request Request object.
* @return WP_Error|stdClass $data Post object.
*/
protected function prepare_item_for_database( $request ) {
2017-02-13 21:44:27 +00:00
$id = isset( $request['id'] ) ? absint( $request['id'] ) : 0;
// Type is the most important part here because we need to be using the correct class and methods.
if ( isset( $request['type'] ) ) {
$classname = WC_Product_Factory::get_classname_from_product_type( $request['type'] );
2017-02-09 20:40:35 +00:00
2017-02-13 21:44:27 +00:00
if ( ! class_exists( $classname ) ) {
$classname = 'WC_Product_Simple';
}
$product = new $classname( $id );
} elseif ( isset( $request['id'] ) ) {
$product = wc_get_product( $id );
} else {
$product = new WC_Product_Simple();
2017-02-09 20:40:35 +00:00
}
// Post title.
if ( isset( $request['name'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_name( wp_filter_post_kses( $request['name'] ) );
2017-02-09 20:40:35 +00:00
}
// Post content.
if ( isset( $request['description'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_description( wp_filter_post_kses( $request['description'] ) );
2017-02-09 20:40:35 +00:00
}
// Post excerpt.
if ( isset( $request['short_description'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_short_description( wp_filter_post_kses( $request['short_description'] ) );
2017-02-09 20:40:35 +00:00
}
// Post status.
if ( isset( $request['status'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_status( get_post_status_object( $request['status'] ) ? $request['status'] : 'draft' );
2017-02-09 20:40:35 +00:00
}
// Post slug.
if ( isset( $request['slug'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_slug( $request['slug'] );
2017-02-09 20:40:35 +00:00
}
// Menu order.
if ( isset( $request['menu_order'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_menu_order( $request['menu_order'] );
2017-02-09 20:40:35 +00:00
}
// Comment status.
if ( isset( $request['reviews_allowed'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_reviews_allowed( $request['reviews_allowed'] );
2017-02-09 20:40:35 +00:00
}
/**
* Filter the query_vars used in `get_items` for the constructed query.
*
* The dynamic portion of the hook name, $this->post_type, refers to post_type of the post being
* prepared for insertion.
*
2017-02-13 21:44:27 +00:00
* @param WC_Product $product An object representing a single item prepared
2017-02-09 20:40:35 +00:00
* for inserting or updating the database.
* @param WP_REST_Request $request Request object.
*/
2017-02-13 21:44:27 +00:00
return apply_filters( "woocommerce_rest_pre_insert_{$this->post_type}", $product, $request );
}
/**
* Create a single product.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|WP_REST_Response
*/
public function create_item( $request ) {
if ( ! empty( $request['id'] ) ) {
return new WP_Error( "woocommerce_rest_{$this->post_type}_exists", sprintf( __( 'Cannot create existing %s.', 'woocommerce' ), $this->post_type ), array( 'status' => 400 ) );
}
$product_id = 0;
try {
$product_id = $this->save_product( $request );
$post = get_post( $product_id );
$this->update_additional_fields_for_object( $post, $request );
$this->update_post_meta_fields( $post, $request );
/**
* Fires after a single item is created or updated via the REST API.
*
* @param WP_Post $post Post data.
* @param WP_REST_Request $request Request object.
* @param boolean $creating True when creating item, false when updating.
*/
do_action( 'woocommerce_rest_insert_product', $post, $request, true );
$request->set_param( 'context', 'edit' );
$response = $this->prepare_item_for_response( $post, $request );
$response = rest_ensure_response( $response );
$response->set_status( 201 );
$response->header( 'Location', rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $post->ID ) ) );
return $response;
} catch ( WC_Data_Exception $e ) {
$this->delete_post( $product_id );
return new WP_Error( $e->getErrorCode(), $e->getMessage(), $e->getErrorData() );
} catch ( WC_REST_Exception $e ) {
$this->delete_post( $product_id );
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
}
/**
* Update a single product.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|WP_REST_Response
*/
public function update_item( $request ) {
$post_id = (int) $request['id'];
if ( empty( $post_id ) || get_post_type( $post_id ) !== $this->post_type ) {
return new WP_Error( "woocommerce_rest_{$this->post_type}_invalid_id", __( 'ID is invalid.', 'woocommerce' ), array( 'status' => 400 ) );
}
try {
$product_id = $this->save_product( $request );
$post = get_post( $product_id );
$this->update_additional_fields_for_object( $post, $request );
$this->update_post_meta_fields( $post, $request );
/**
* Fires after a single item is created or updated via the REST API.
*
* @param WP_Post $post Post data.
* @param WP_REST_Request $request Request object.
* @param boolean $creating True when creating item, false when updating.
*/
do_action( 'woocommerce_rest_insert_product', $post, $request, false );
$request->set_param( 'context', 'edit' );
$response = $this->prepare_item_for_response( $post, $request );
return rest_ensure_response( $response );
} catch ( WC_Data_Exception $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), $e->getErrorData() );
} catch ( WC_REST_Exception $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
}
/**
* Saves a product to the database.
*
* @param WP_REST_Request $request Full details about the request.
* @return int
*/
public function save_product( $request ) {
$product = $this->prepare_item_for_database( $request );
return $product->save();
2017-02-09 20:40:35 +00:00
}
/**
* Save product images.
*
2017-02-13 21:44:27 +00:00
* @deprecated 2.7.0
2017-02-09 20:40:35 +00:00
* @param int $product_id
* @param array $images
* @throws WC_REST_Exception
*/
protected function save_product_images( $product_id, $images ) {
2017-02-13 21:44:27 +00:00
$product = wc_get_product( $product_id );
return set_product_images( $product, $images );
}
/**
* Set product images.
*
* @throws WC_REST_Exception REST API exceptions.
* @param WC_Product $product Product instance.
* @param array $images Images data.
* @return WC_Product
*/
protected function set_product_images( $product, $images ) {
2017-02-09 20:40:35 +00:00
if ( is_array( $images ) ) {
$gallery = array();
foreach ( $images as $image ) {
$attachment_id = isset( $image['id'] ) ? absint( $image['id'] ) : 0;
if ( 0 === $attachment_id && isset( $image['src'] ) ) {
$upload = wc_rest_upload_image_from_url( esc_url_raw( $image['src'] ) );
if ( is_wp_error( $upload ) ) {
2017-02-13 21:44:27 +00:00
if ( ! apply_filters( 'woocommerce_rest_suppress_image_upload_error', false, $upload, $product->get_id(), $images ) ) {
throw new WC_REST_Exception( 'woocommerce_product_image_upload_error', $upload->get_error_message(), 400 );
} else {
continue;
}
2017-02-09 20:40:35 +00:00
}
2017-02-13 21:44:27 +00:00
$attachment_id = wc_rest_set_uploaded_image_as_attachment( $upload, $product->get_id() );
2017-02-09 20:40:35 +00:00
}
if ( ! wp_attachment_is_image( $attachment_id ) ) {
throw new WC_REST_Exception( 'woocommerce_product_invalid_image_id', sprintf( __( '#%s is an invalid image ID.', 'woocommerce' ), $attachment_id ), 400 );
}
if ( isset( $image['position'] ) && 0 === absint( $image['position'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_image_id( $attachment_id );
2017-02-09 20:40:35 +00:00
} else {
$gallery[] = $attachment_id;
}
// Set the image alt if present.
if ( ! empty( $image['alt'] ) ) {
update_post_meta( $attachment_id, '_wp_attachment_image_alt', wc_clean( $image['alt'] ) );
}
// Set the image name if present.
if ( ! empty( $image['name'] ) ) {
wp_update_post( array( 'ID' => $attachment_id, 'post_title' => $image['name'] ) );
}
}
if ( ! empty( $gallery ) ) {
2017-02-13 21:44:27 +00:00
$product->set_gallery_image_ids( $gallery );
2017-02-09 20:40:35 +00:00
}
} else {
2017-02-13 21:44:27 +00:00
$product->set_image_id( '' );
$product->set_gallery_image_ids( array() );
2017-02-09 20:40:35 +00:00
}
2017-02-13 21:44:27 +00:00
return $product;
2017-02-09 20:40:35 +00:00
}
/**
* Save product shipping data.
*
2017-02-13 21:44:27 +00:00
* @param WC_Product $product Product instance.
* @param array $data Shipping data.
* @return WC_Product
2017-02-09 20:40:35 +00:00
*/
2017-02-16 04:30:04 +00:00
protected function save_product_shipping_data( $product, $data ) {
2017-02-09 20:40:35 +00:00
// Virtual.
if ( isset( $data['virtual'] ) && true === $data['virtual'] ) {
2017-02-13 21:44:27 +00:00
$product->set_weight( '' );
$product->set_height( '' );
$product->set_length( '' );
$product->set_width( '' );
2017-02-09 20:40:35 +00:00
} else {
if ( isset( $data['weight'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_weight( $data['weight'] );
2017-02-09 20:40:35 +00:00
}
// Height.
if ( isset( $data['dimensions']['height'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_height( $data['dimensions']['height'] );
2017-02-09 20:40:35 +00:00
}
// Width.
if ( isset( $data['dimensions']['width'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_width( $data['dimensions']['width'] );
2017-02-09 20:40:35 +00:00
}
// Length.
if ( isset( $data['dimensions']['length'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_length( $data['dimensions']['length'] );
2017-02-09 20:40:35 +00:00
}
}
// Shipping class.
if ( isset( $data['shipping_class'] ) ) {
2017-02-13 21:44:27 +00:00
$shipping_class_term = get_term_by( 'slug', wc_clean( $data['shipping_class'] ), 'product_shipping_class' );
if ( $shipping_class_term ) {
$product->set_shipping_class_id( $shipping_class_term->term_id );
}
2017-02-09 20:40:35 +00:00
}
2017-02-13 21:44:27 +00:00
return $product;
2017-02-09 20:40:35 +00:00
}
/**
* Save downloadable files.
*
2017-02-13 21:44:27 +00:00
* @param WC_Product $product Product instance.
* @param array $downloads Downloads data.
* @param int $deprecated Deprecated since 2.7.
* @return WC_Product
2017-02-09 20:40:35 +00:00
*/
2017-02-16 04:30:04 +00:00
protected function save_downloadable_files( $product, $downloads, $deprecated = 0 ) {
2017-02-13 21:44:27 +00:00
if ( $deprecated ) {
wc_deprecated_argument( 'variation_id', '2.7', 'save_downloadable_files() not requires a variation_id anymore.' );
}
2017-02-09 20:40:35 +00:00
2017-02-13 21:44:27 +00:00
$files = array();
2017-02-09 20:40:35 +00:00
foreach ( $downloads as $key => $file ) {
2017-02-13 21:44:27 +00:00
if ( empty( $file['file'] ) ) {
2017-02-09 20:40:35 +00:00
continue;
}
2017-02-13 21:44:27 +00:00
$download = new WC_Product_Download();
$download->set_id( $key );
$download->set_name( $file['name'] ? $file['name'] : wc_get_filename_from_url( $file['file'] ) );
$download->set_file( apply_filters( 'woocommerce_file_download_path', $file['file'], $product, $key ) );
$files[] = $download;
2017-02-09 20:40:35 +00:00
}
2017-02-13 21:44:27 +00:00
$product->set_downloads( $files );
2017-02-09 20:40:35 +00:00
2017-02-13 21:44:27 +00:00
return $product;
2017-02-09 20:40:35 +00:00
}
/**
* Save taxonomy terms.
*
2017-02-13 21:44:27 +00:00
* @param WC_Product $product Product instance.
* @param array $terms Terms data.
* @param string $taxonomy Taxonomy name.
* @return WC_Product
2017-02-09 20:40:35 +00:00
*/
2017-02-13 21:44:27 +00:00
protected function save_taxonomy_terms( $product, $terms, $taxonomy = 'cat' ) {
2017-02-09 20:40:35 +00:00
$term_ids = wp_list_pluck( $terms, 'id' );
2017-02-13 21:44:27 +00:00
if ( 'cat' === $taxonomy ) {
$product->set_category_ids( $term_ids );
} elseif ( 'tag' === $taxonomy ) {
$product->set_tag_ids( $term_ids );
}
2017-02-09 20:40:35 +00:00
2017-02-13 21:44:27 +00:00
return $product;
}
/**
* Save default attributes.
*
* @since 2.7.0
*
* @param WC_Product $product Product instance.
* @param WP_REST_Request $request Request data.
* @return WC_Product
*/
protected function save_default_attributes( $product, $request ) {
if ( isset( $request['default_attributes'] ) && is_array( $request['default_attributes'] ) ) {
$attributes = $product->get_variation_attributes();
$default_attributes = array();
foreach ( $request['default_attributes'] as $attribute ) {
$attribute_id = 0;
$attribute_name = '';
// Check ID for global attributes or name for product attributes.
if ( ! empty( $attribute['id'] ) ) {
$attribute_id = absint( $attribute['id'] );
$attribute_name = wc_attribute_taxonomy_name_by_id( $attribute_id );
} elseif ( ! empty( $attribute['name'] ) ) {
$attribute_name = sanitize_title( $attribute['name'] );
}
if ( ! $attribute_id && ! $attribute_name ) {
continue;
}
if ( isset( $attributes[ $attribute_name ] ) ) {
$_attribute = $attributes[ $attribute_name ];
if ( $_attribute['is_variation'] ) {
$value = isset( $attribute['option'] ) ? wc_clean( stripslashes( $attribute['option'] ) ) : '';
if ( ! empty( $_attribute['is_taxonomy'] ) ) {
// If dealing with a taxonomy, we need to get the slug from the name posted to the API.
$term = get_term_by( 'name', $value, $attribute_name );
if ( $term && ! is_wp_error( $term ) ) {
$value = $term->slug;
} else {
$value = sanitize_title( $value );
}
}
if ( $value ) {
$default_attributes[ $attribute_name ] = $value;
}
}
}
}
$product->set_default_attributes( $default_attributes );
}
return $product;
2017-02-09 20:40:35 +00:00
}
/**
* Save product meta.
*
2017-02-13 21:44:27 +00:00
* @deprecated 2.7.0
2017-02-09 20:40:35 +00:00
* @param WC_Product $product
* @param WP_REST_Request $request
* @return bool
* @throws WC_REST_Exception
*/
protected function save_product_meta( $product, $request ) {
$product = $this->set_product_meta( $product, $request );
$product->save();
2017-02-09 20:40:35 +00:00
2017-02-13 21:44:27 +00:00
return true;
}
2017-02-09 20:40:35 +00:00
2017-02-13 21:44:27 +00:00
/**
* Set product meta.
*
* @throws WC_REST_Exception REST API exceptions.
* @param WC_Product $product Product instance.
* @param WP_REST_Request $request Request data.
* @return WC_Product
*/
protected function set_product_meta( $product, $request ) {
2017-02-09 20:40:35 +00:00
// Virtual.
if ( isset( $request['virtual'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_virtual( $request['virtual'] );
2017-02-09 20:40:35 +00:00
}
// Tax status.
if ( isset( $request['tax_status'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_tax_status( $request['tax_status'] );
2017-02-09 20:40:35 +00:00
}
// Tax Class.
if ( isset( $request['tax_class'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_tax_class( $request['tax_class'] );
2017-02-09 20:40:35 +00:00
}
// Catalog Visibility.
if ( isset( $request['catalog_visibility'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_catalog_visibility( $request['catalog_visibility'] );
2017-02-09 20:40:35 +00:00
}
// Purchase Note.
if ( isset( $request['purchase_note'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_purchase_note( wc_clean( $request['purchase_note'] ) );
2017-02-09 20:40:35 +00:00
}
// Featured Product.
if ( isset( $request['featured'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_featured( $request['featured'] );
2017-02-09 20:40:35 +00:00
}
// Shipping data.
2017-02-13 21:44:27 +00:00
$product = $this->save_product_shipping_data( $product, $request );
2017-02-09 20:40:35 +00:00
// SKU.
if ( isset( $request['sku'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_sku( wc_clean( $request['sku'] ) );
2017-02-09 20:40:35 +00:00
}
// Attributes.
if ( isset( $request['attributes'] ) ) {
$attributes = array();
foreach ( $request['attributes'] as $attribute ) {
$attribute_id = 0;
$attribute_name = '';
// Check ID for global attributes or name for product attributes.
if ( ! empty( $attribute['id'] ) ) {
$attribute_id = absint( $attribute['id'] );
$attribute_name = wc_attribute_taxonomy_name_by_id( $attribute_id );
} elseif ( ! empty( $attribute['name'] ) ) {
$attribute_name = wc_clean( $attribute['name'] );
}
if ( ! $attribute_id && ! $attribute_name ) {
continue;
}
if ( $attribute_id ) {
if ( isset( $attribute['options'] ) ) {
$options = $attribute['options'];
if ( ! is_array( $attribute['options'] ) ) {
// Text based attributes - Posted values are term names.
$options = explode( WC_DELIMITER, $options );
}
$values = array_map( 'wc_sanitize_term_text_based', $options );
$values = array_filter( $values, 'strlen' );
} else {
$values = array();
}
if ( ! empty( $values ) ) {
// Add attribute to array, but don't set values.
2017-02-13 21:44:27 +00:00
$attribute_object = new WC_Product_Attribute();
$attribute_object->set_id( $attribute_id );
$attribute_object->set_name( $attribute_name );
$attribute_object->set_options( $values );
$attribute_object->set_position( isset( $attribute['position'] ) ? (string) absint( $attribute['position'] ) : '0' );
$attribute_object->set_visible( ( isset( $attribute['visible'] ) && $attribute['visible'] ) ? 1 : 0 );
$attribute_object->set_variation( ( isset( $attribute['variation'] ) && $attribute['variation'] ) ? 1 : 0 );
$attributes[] = $attribute_object;
2017-02-09 20:40:35 +00:00
}
} elseif ( isset( $attribute['options'] ) ) {
2017-02-13 21:44:27 +00:00
// Custom attribute - Add attribute to array and set the values.
2017-02-09 20:40:35 +00:00
if ( is_array( $attribute['options'] ) ) {
2017-02-13 21:44:27 +00:00
$values = $attribute['options'];
2017-02-09 20:40:35 +00:00
} else {
2017-02-13 21:44:27 +00:00
$values = explode( WC_DELIMITER, $attribute['options'] );
2017-02-09 20:40:35 +00:00
}
2017-02-13 21:44:27 +00:00
$attribute_object = new WC_Product_Attribute();
$attribute_object->set_name( $attribute_name );
$attribute_object->set_options( $values );
$attribute_object->set_position( isset( $attribute['position'] ) ? (string) absint( $attribute['position'] ) : '0' );
$attribute_object->set_visible( ( isset( $attribute['visible'] ) && $attribute['visible'] ) ? 1 : 0 );
$attribute_object->set_variation( ( isset( $attribute['variation'] ) && $attribute['variation'] ) ? 1 : 0 );
$attributes[] = $attribute_object;
2017-02-09 20:40:35 +00:00
}
}
2017-02-13 21:44:27 +00:00
$product->set_attributes( $attributes );
2017-02-09 20:40:35 +00:00
}
// Sales and prices.
2017-02-13 21:44:27 +00:00
if ( in_array( $product->get_type(), array( 'variable', 'grouped' ), true ) ) {
$product->set_regular_price( '' );
$product->set_sale_price( '' );
$product->set_date_on_sale_to( '' );
$product->set_date_on_sale_from( '' );
$product->set_price( '' );
2017-02-09 20:40:35 +00:00
} else {
2017-02-13 21:44:27 +00:00
// Regular Price.
2017-02-09 20:40:35 +00:00
if ( isset( $request['regular_price'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_regular_price( $request['regular_price'] );
2017-02-09 20:40:35 +00:00
}
2017-02-13 21:44:27 +00:00
// Sale Price.
2017-02-09 20:40:35 +00:00
if ( isset( $request['sale_price'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_sale_price( $request['sale_price'] );
2017-02-09 20:40:35 +00:00
}
if ( isset( $request['date_on_sale_from'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_date_on_sale_from( $request['date_on_sale_from'] );
2017-02-09 20:40:35 +00:00
}
if ( isset( $request['date_on_sale_to'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_date_on_sale_to( $request['date_on_sale_to'] );
2017-02-09 20:40:35 +00:00
}
}
// Product parent ID for groups.
if ( isset( $request['parent_id'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_parent_id( $request['parent_id'] );
2017-02-09 20:40:35 +00:00
}
// Sold individually.
if ( isset( $request['sold_individually'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_sold_individually( $request['sold_individually'] );
2017-02-09 20:40:35 +00:00
}
// Stock status.
if ( isset( $request['in_stock'] ) ) {
$stock_status = true === $request['in_stock'] ? 'instock' : 'outofstock';
} else {
2017-02-13 21:44:27 +00:00
$stock_status = $product->get_stock_status();
2017-02-09 20:40:35 +00:00
}
// Stock data.
if ( 'yes' === get_option( 'woocommerce_manage_stock' ) ) {
// Manage stock.
if ( isset( $request['manage_stock'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_manage_stock( $request['manage_stock'] );
2017-02-09 20:40:35 +00:00
}
// Backorders.
if ( isset( $request['backorders'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_backorders( $request['backorders'] );
}
if ( $product->is_type( 'grouped' ) ) {
$product->set_manage_stock( 'no' );
$product->set_backorders( 'no' );
$product->set_stock_quantity( '' );
$product->set_stock_status( $stock_status );
} elseif ( $product->is_type( 'external' ) ) {
$product->set_manage_stock( 'no' );
$product->set_backorders( 'no' );
$product->set_stock_quantity( '' );
$product->set_stock_status( 'instock' );
} elseif ( $product->get_manage_stock() ) {
2017-02-09 20:40:35 +00:00
// Stock status is always determined by children so sync later.
2017-02-13 21:44:27 +00:00
if ( ! $product->is_type( 'variable' ) ) {
$product->set_stock_status( $stock_status );
2017-02-09 20:40:35 +00:00
}
// Stock quantity.
if ( isset( $request['stock_quantity'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_stock_quantity( wc_stock_amount( $request['stock_quantity'] ) );
2017-02-09 20:40:35 +00:00
} elseif ( isset( $request['inventory_delta'] ) ) {
2017-02-13 21:44:27 +00:00
$stock_quantity = wc_stock_amount( $product->get_stock_quantity() );
2017-02-09 20:40:35 +00:00
$stock_quantity += wc_stock_amount( $request['inventory_delta'] );
2017-02-13 21:44:27 +00:00
$product->set_stock_quantity( wc_stock_amount( $stock_quantity ) );
2017-02-09 20:40:35 +00:00
}
} else {
// Don't manage stock.
2017-02-13 21:44:27 +00:00
$product->set_manage_stock( 'no' );
$product->set_stock_quantity( '' );
$product->set_stock_status( $stock_status );
2017-02-09 20:40:35 +00:00
}
2017-02-13 21:44:27 +00:00
} elseif ( ! $product->is_type( 'variable' ) ) {
$product->set_stock_status( $stock_status );
2017-02-09 20:40:35 +00:00
}
// Upsells.
if ( isset( $request['upsell_ids'] ) ) {
$upsells = array();
$ids = $request['upsell_ids'];
if ( ! empty( $ids ) ) {
foreach ( $ids as $id ) {
if ( $id && $id > 0 ) {
$upsells[] = $id;
}
}
}
2017-02-13 21:44:27 +00:00
$product->set_upsell_ids( $upsells );
2017-02-09 20:40:35 +00:00
}
// Cross sells.
if ( isset( $request['cross_sell_ids'] ) ) {
$crosssells = array();
$ids = $request['cross_sell_ids'];
if ( ! empty( $ids ) ) {
foreach ( $ids as $id ) {
if ( $id && $id > 0 ) {
$crosssells[] = $id;
}
}
}
2017-02-13 21:44:27 +00:00
$product->set_cross_sell_ids( $crosssells );
2017-02-09 20:40:35 +00:00
}
// Product categories.
if ( isset( $request['categories'] ) && is_array( $request['categories'] ) ) {
2017-02-13 21:44:27 +00:00
$product = $this->save_taxonomy_terms( $product, $request['categories'] );
2017-02-09 20:40:35 +00:00
}
// Product tags.
if ( isset( $request['tags'] ) && is_array( $request['tags'] ) ) {
2017-02-13 21:44:27 +00:00
$product = $this->save_taxonomy_terms( $product, $request['tags'], 'tag' );
2017-02-09 20:40:35 +00:00
}
// Downloadable.
if ( isset( $request['downloadable'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_downloadable( $request['downloadable'] );
2017-02-09 20:40:35 +00:00
}
// Downloadable options.
2017-02-13 21:44:27 +00:00
if ( $product->get_downloadable() ) {
2017-02-09 20:40:35 +00:00
// Downloadable files.
if ( isset( $request['downloads'] ) && is_array( $request['downloads'] ) ) {
2017-02-13 21:44:27 +00:00
$product = $this->save_downloadable_files( $product, $request['downloads'] );
2017-02-09 20:40:35 +00:00
}
// Download limit.
if ( isset( $request['download_limit'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_download_limit( $request['download_limit'] );
2017-02-09 20:40:35 +00:00
}
// Download expiry.
if ( isset( $request['download_expiry'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_download_expiry( $request['download_expiry'] );
2017-02-09 20:40:35 +00:00
}
}
// Product url and button text for external products.
2017-02-13 21:44:27 +00:00
if ( $product->is_type( 'external' ) ) {
2017-02-09 20:40:35 +00:00
if ( isset( $request['external_url'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_product_url( $request['external_url'] );
2017-02-09 20:40:35 +00:00
}
if ( isset( $request['button_text'] ) ) {
2017-02-13 21:44:27 +00:00
$product->set_button_text( $request['button_text'] );
2017-02-09 20:40:35 +00:00
}
}
2017-02-13 21:44:27 +00:00
// Save default attributes for variable products.
if ( $product->is_type( 'variable' ) ) {
$product = $this->save_default_attributes( $product, $request );
}
return $product;
2017-02-09 20:40:35 +00:00
}
/**
* Save variations.
*
2017-02-13 21:44:27 +00:00
* @throws WC_REST_Exception REST API exceptions.
* @param WC_Product $product Product instance.
* @param WP_REST_Request $request Request data.
2017-02-09 20:40:35 +00:00
* @return bool
*/
protected function save_variations_data( $product, $request ) {
foreach ( $request['variations'] as $menu_order => $data ) {
$variation = new WC_Product_Variation( isset( $data['id'] ) ? absint( $data['id'] ) : 0 );
2017-02-09 20:40:35 +00:00
2017-02-13 21:44:27 +00:00
// Create initial name and status.
if ( ! $variation->get_slug() ) {
/* translators: 1: variation id 2: product name */
$variation->set_name( sprintf( __( 'Variation #%1$s of %2$s', 'woocommerce' ), $variation->get_id(), $product->get_name() ) );
$variation->set_status( isset( $data['visible'] ) && false === $data['visible'] ? 'private' : 'publish' );
}
2017-02-09 20:40:35 +00:00
2017-02-13 21:44:27 +00:00
// Parent ID.
$variation->set_parent_id( $product->get_id() );
2017-02-09 20:40:35 +00:00
2017-02-13 21:44:27 +00:00
// Menu order.
$variation->set_menu_order( $menu_order );
2017-02-09 20:40:35 +00:00
2017-02-13 21:44:27 +00:00
// Status.
if ( isset( $data['visible'] ) ) {
$variation->set_status( false === $data['visible'] ? 'private' : 'publish' );
2017-02-09 20:40:35 +00:00
}
// SKU.
2017-02-13 21:44:27 +00:00
if ( isset( $data['sku'] ) ) {
$variation->set_sku( wc_clean( $data['sku'] ) );
2017-02-09 20:40:35 +00:00
}
// Thumbnail.
2017-02-13 21:44:27 +00:00
if ( isset( $data['image'] ) && is_array( $data['image'] ) ) {
$image = $data['image'];
$image = current( $image );
if ( is_array( $image ) ) {
$image['position'] = 0;
2017-02-09 20:40:35 +00:00
}
2017-02-13 21:44:27 +00:00
$variation = $this->set_product_images( $variation, array( $image ) );
2017-02-09 20:40:35 +00:00
}
// Virtual variation.
2017-02-13 21:44:27 +00:00
if ( isset( $data['virtual'] ) ) {
$variation->set_virtual( $data['virtual'] );
2017-02-09 20:40:35 +00:00
}
// Downloadable variation.
2017-02-13 21:44:27 +00:00
if ( isset( $data['downloadable'] ) ) {
$variation->set_downloadable( $data['downloadable'] );
2017-02-09 20:40:35 +00:00
}
2017-02-13 21:44:27 +00:00
// Downloads.
if ( $variation->get_downloadable() ) {
// Downloadable files.
if ( isset( $data['downloads'] ) && is_array( $data['downloads'] ) ) {
$variation = $this->save_downloadable_files( $variation, $data['downloads'] );
}
2017-02-09 20:40:35 +00:00
2017-02-13 21:44:27 +00:00
// Download limit.
if ( isset( $data['download_limit'] ) ) {
$variation->set_download_limit( $data['download_limit'] );
}
2017-02-09 20:40:35 +00:00
2017-02-13 21:44:27 +00:00
// Download expiry.
if ( isset( $data['download_expiry'] ) ) {
$variation->set_download_expiry( $data['download_expiry'] );
}
2017-02-09 20:40:35 +00:00
}
2017-02-13 21:44:27 +00:00
// Shipping data.
$variation = $this->save_product_shipping_data( $variation, $data );
2017-02-09 20:40:35 +00:00
2017-02-13 21:44:27 +00:00
// Stock handling.
if ( isset( $data['manage_stock'] ) ) {
$variation->set_manage_stock( $data['manage_stock'] );
}
2017-02-09 20:40:35 +00:00
2017-02-13 21:44:27 +00:00
if ( isset( $data['in_stock'] ) ) {
$variation->set_stock_status( true === $data['in_stock'] ? 'instock' : 'outofstock' );
}
2017-02-09 20:40:35 +00:00
2017-02-13 21:44:27 +00:00
if ( isset( $data['backorders'] ) ) {
$variation->set_backorders( $data['backorders'] );
}
2017-02-09 20:40:35 +00:00
2017-02-13 21:44:27 +00:00
if ( $variation->get_manage_stock() ) {
if ( isset( $data['stock_quantity'] ) ) {
$variation->set_stock_quantity( $data['stock_quantity'] );
} elseif ( isset( $data['inventory_delta'] ) ) {
$stock_quantity = wc_stock_amount( $variation->get_stock_quantity() );
$stock_quantity += wc_stock_amount( $data['inventory_delta'] );
$variation->set_stock_quantity( $stock_quantity );
2017-02-09 20:40:35 +00:00
}
} else {
2017-02-13 21:44:27 +00:00
$variation->set_backorders( 'no' );
$variation->set_stock_quantity( '' );
2017-02-09 20:40:35 +00:00
}
// Regular Price.
2017-02-13 21:44:27 +00:00
if ( isset( $data['regular_price'] ) ) {
$variation->set_regular_price( $data['regular_price'] );
2017-02-09 20:40:35 +00:00
}
// Sale Price.
2017-02-13 21:44:27 +00:00
if ( isset( $data['sale_price'] ) ) {
$variation->set_sale_price( $data['sale_price'] );
2017-02-09 20:40:35 +00:00
}
2017-02-13 21:44:27 +00:00
if ( isset( $data['date_on_sale_from'] ) ) {
$variation->set_date_on_sale_from( $data['date_on_sale_from'] );
2017-02-09 20:40:35 +00:00
}
2017-02-13 21:44:27 +00:00
if ( isset( $data['date_on_sale_to'] ) ) {
$variation->set_date_on_sale_to( $data['date_on_sale_to'] );
2017-02-09 20:40:35 +00:00
}
// Tax class.
2017-02-13 21:44:27 +00:00
if ( isset( $data['tax_class'] ) ) {
$variation->set_tax_class( $data['tax_class'] );
2017-02-09 20:40:35 +00:00
}
// Description.
2017-02-13 21:44:27 +00:00
if ( isset( $data['description'] ) ) {
$variation->set_description( wp_kses_post( $data['description'] ) );
2017-02-09 20:40:35 +00:00
}
// Update taxonomies.
2017-02-13 21:44:27 +00:00
if ( isset( $data['attributes'] ) ) {
$attributes = array();
$parent_attributes = $product->get_attributes();
2017-02-09 20:40:35 +00:00
2017-02-13 21:44:27 +00:00
foreach ( $data['attributes'] as $attribute ) {
2017-02-09 20:40:35 +00:00
$attribute_id = 0;
$attribute_name = '';
// Check ID for global attributes or name for product attributes.
if ( ! empty( $attribute['id'] ) ) {
$attribute_id = absint( $attribute['id'] );
$attribute_name = wc_attribute_taxonomy_name_by_id( $attribute_id );
} elseif ( ! empty( $attribute['name'] ) ) {
$attribute_name = sanitize_title( $attribute['name'] );
}
if ( ! $attribute_id && ! $attribute_name ) {
continue;
}
2017-02-13 21:44:27 +00:00
if ( ! isset( $parent_attributes[ $attribute_name ] ) || ! $parent_attributes[ $attribute_name ]->get_variation() ) {
continue;
2017-02-09 20:40:35 +00:00
}
2017-02-13 21:44:27 +00:00
$attribute_key = sanitize_title( $parent_attributes[ $attribute_name ]->get_name() );
$attribute_value = isset( $attribute['option'] ) ? wc_clean( stripslashes( $attribute['option'] ) ) : '';
2017-02-09 20:40:35 +00:00
2017-02-13 21:44:27 +00:00
if ( $parent_attributes[ $attribute_name ]->is_taxonomy() ) {
// If dealing with a taxonomy, we need to get the slug from the name posted to the API.
$term = get_term_by( 'name', $attribute_value, $attribute_name );
2017-02-09 20:40:35 +00:00
2017-02-13 21:44:27 +00:00
if ( $term && ! is_wp_error( $term ) ) {
$attribute_value = $term->slug;
} else {
$attribute_value = sanitize_title( $attribute_value );
2017-02-09 20:40:35 +00:00
}
}
2017-02-13 21:44:27 +00:00
$attributes[ $attribute_key ] = $attribute_value;
2017-02-09 20:40:35 +00:00
}
2017-02-13 21:44:27 +00:00
$variation->set_attributes( $attributes );
2017-02-09 20:40:35 +00:00
}
2017-02-13 21:44:27 +00:00
$variation->save();
do_action( 'woocommerce_rest_save_product_variation', $variation->get_id(), $menu_order, $data );
2017-02-09 20:40:35 +00:00
}
return true;
}
/**
* Add post meta fields.
*
2017-02-13 21:44:27 +00:00
* @param WP_Post $post Post data.
* @param WP_REST_Request $request Request data.
2017-02-09 20:40:35 +00:00
* @return bool|WP_Error
*/
protected function add_post_meta_fields( $post, $request ) {
2017-02-13 21:44:27 +00:00
return $this->update_post_meta_fields( $post, $request );
2017-02-09 20:40:35 +00:00
}
/**
* Update post meta fields.
*
2017-02-13 21:44:27 +00:00
* @param WP_Post $post Post data.
* @param WP_REST_Request $request Request data.
2017-02-09 20:40:35 +00:00
* @return bool|WP_Error
*/
protected function update_post_meta_fields( $post, $request ) {
2017-02-13 21:44:27 +00:00
$product = wc_get_product( $post );
2017-02-09 20:40:35 +00:00
2017-02-13 21:44:27 +00:00
// Check for featured/gallery images, upload it and set it.
if ( isset( $request['images'] ) ) {
$product = $this->set_product_images( $product, $request['images'] );
}
2017-02-09 20:40:35 +00:00
2017-02-13 21:44:27 +00:00
// Save product meta fields.
$product = $this->set_product_meta( $product, $request );
2017-02-09 20:40:35 +00:00
2017-02-13 21:44:27 +00:00
// Save the product data.
$product->save();
2017-02-09 20:40:35 +00:00
2017-02-13 21:44:27 +00:00
// Save variations.
if ( $product->is_type( 'variable' ) ) {
if ( isset( $request['variations'] ) && is_array( $request['variations'] ) ) {
$this->save_variations_data( $product, $request );
}
2017-02-09 20:40:35 +00:00
}
2017-02-13 21:44:27 +00:00
// Clear caches here so in sync with any new variations/children.
wc_delete_product_transients( $product->get_id() );
wp_cache_delete( 'product-' . $product->get_id(), 'products' );
return true;
2017-02-09 20:40:35 +00:00
}
/**
* Clear cache/transients.
*
* @param WP_Post $post Post data.
*/
public function clear_transients( $post ) {
wc_delete_product_transients( $post->ID );
}
/**
* Delete post.
*
2017-02-13 21:44:27 +00:00
* @param int|WP_Post $id Post ID or WP_Post instance.
2017-02-09 20:40:35 +00:00
*/
2017-02-13 21:44:27 +00:00
protected function delete_post( $id ) {
if ( ! empty( $id->ID ) ) {
$id = $id->ID;
} elseif ( ! is_numeric( $id ) || 0 >= $id ) {
return;
}
2017-02-09 20:40:35 +00:00
// Delete product attachments.
2017-02-13 21:44:27 +00:00
$attachments = get_posts( array(
'post_parent' => $id,
2017-02-09 20:40:35 +00:00
'post_status' => 'any',
'post_type' => 'attachment',
) );
foreach ( (array) $attachments as $attachment ) {
wp_delete_attachment( $attachment->ID, true );
}
// Delete product.
2017-02-13 21:44:27 +00:00
$product = wc_get_product( $id );
$product->delete( true );
2017-02-09 20:40:35 +00:00
}
/**
* Delete a single item.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error
*/
public function delete_item( $request ) {
2017-02-13 21:44:27 +00:00
$id = (int) $request['id'];
$force = (bool) $request['force'];
$post = get_post( $id );
$product = wc_get_product( $id );
2017-02-09 20:40:35 +00:00
2017-02-13 21:44:27 +00:00
if ( ! empty( $post->post_type ) && 'product_variation' === $post->post_type && 'product' === $this->post_type ) {
return new WP_Error( "woocommerce_rest_invalid_{$this->post_type}_id", __( 'To manipulate product variations you should use the /products/&lt;product_id&gt;/variations/&lt;id&gt; endpoint.', 'woocommerce' ), array( 'status' => 404 ) );
} elseif ( empty( $id ) || empty( $post->ID ) || $post->post_type !== $this->post_type ) {
return new WP_Error( "woocommerce_rest_{$this->post_type}_invalid_id", __( 'Invalid post ID.', 'woocommerce' ), array( 'status' => 404 ) );
2017-02-09 20:40:35 +00:00
}
$supports_trash = EMPTY_TRASH_DAYS > 0;
/**
* Filter whether an item is trashable.
*
* Return false to disable trash support for the item.
*
* @param boolean $supports_trash Whether the item type support trashing.
* @param WP_Post $post The Post object being considered for trashing support.
*/
$supports_trash = apply_filters( "woocommerce_rest_{$this->post_type}_trashable", $supports_trash, $post );
if ( ! wc_rest_check_post_permissions( $this->post_type, 'delete', $post->ID ) ) {
2017-02-13 21:44:27 +00:00
/* translators: %s: post type */
2017-02-09 20:40:35 +00:00
return new WP_Error( "woocommerce_rest_user_cannot_delete_{$this->post_type}", sprintf( __( 'Sorry, you are not allowed to delete %s.', 'woocommerce' ), $this->post_type ), array( 'status' => rest_authorization_required_code() ) );
}
$request->set_param( 'context', 'edit' );
$response = $this->prepare_item_for_response( $post, $request );
// If we're forcing, then delete permanently.
if ( $force ) {
2017-02-13 21:44:27 +00:00
if ( $product->is_type( 'variable' ) ) {
foreach ( $product->get_children() as $child_id ) {
$child = wc_get_product( $child_id );
$child->delete( true );
2017-02-09 20:40:35 +00:00
}
2017-02-13 21:44:27 +00:00
} elseif ( $product->is_type( 'grouped' ) ) {
foreach ( $product->get_children() as $child_id ) {
$child = wc_get_product( $child_id );
$child->set_parent_id( 0 );
$child->save();
2017-02-09 20:40:35 +00:00
}
}
2017-02-13 21:44:27 +00:00
$product->delete( true );
$result = $product->get_id() > 0 ? false : true;
2017-02-09 20:40:35 +00:00
} else {
// If we don't support trashing for this type, error out.
if ( ! $supports_trash ) {
2017-02-13 21:44:27 +00:00
/* translators: %s: post type */
2017-02-09 20:40:35 +00:00
return new WP_Error( 'woocommerce_rest_trash_not_supported', sprintf( __( 'The %s does not support trashing.', 'woocommerce' ), $this->post_type ), array( 'status' => 501 ) );
}
// Otherwise, only trash if we haven't already.
if ( 'trash' === $post->post_status ) {
2017-02-13 21:44:27 +00:00
/* translators: %s: post type */
2017-02-09 20:40:35 +00:00
return new WP_Error( 'woocommerce_rest_already_trashed', sprintf( __( 'The %s has already been deleted.', 'woocommerce' ), $this->post_type ), array( 'status' => 410 ) );
}
// (Note that internally this falls through to `wp_delete_post` if
// the trash is disabled.)
2017-02-13 21:44:27 +00:00
$product->delete();
$result = 'trash' === $product->get_status();
2017-02-09 20:40:35 +00:00
}
if ( ! $result ) {
2017-02-13 21:44:27 +00:00
/* translators: %s: post type */
2017-02-09 20:40:35 +00:00
return new WP_Error( 'woocommerce_rest_cannot_delete', sprintf( __( 'The %s cannot be deleted.', 'woocommerce' ), $this->post_type ), array( 'status' => 500 ) );
}
// Delete parent product transients.
if ( $parent_id = wp_get_post_parent_id( $id ) ) {
wc_delete_product_transients( $parent_id );
}
/**
* Fires after a single item is deleted or trashed via the REST API.
*
* @param object $post The deleted or trashed item.
* @param WP_REST_Response $response The response data.
* @param WP_REST_Request $request The request sent to the API.
*/
do_action( "woocommerce_rest_delete_{$this->post_type}", $post, $response, $request );
return $response;
}
/**
* Get the Product's schema, conforming to JSON Schema.
*
* @return array
*/
public function get_item_schema() {
$weight_unit = get_option( 'woocommerce_weight_unit' );
$dimension_unit = get_option( 'woocommerce_dimension_unit' );
$schema = array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'title' => $this->post_type,
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Unique identifier for the resource.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'name' => array(
'description' => __( 'Product name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'slug' => array(
'description' => __( 'Product slug.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'permalink' => array(
'description' => __( 'Product URL.', 'woocommerce' ),
'type' => 'string',
'format' => 'uri',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'date_created' => array(
'description' => __( "The date the product was created, in the site's timezone.", 'woocommerce' ),
'type' => 'date-time',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'date_modified' => array(
'description' => __( "The date the product was last modified, in the site's timezone.", 'woocommerce' ),
'type' => 'date-time',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'type' => array(
'description' => __( 'Product type.', 'woocommerce' ),
'type' => 'string',
'default' => 'simple',
'enum' => array_keys( wc_get_product_types() ),
'context' => array( 'view', 'edit' ),
),
'status' => array(
'description' => __( 'Product status (post status).', 'woocommerce' ),
'type' => 'string',
'default' => 'publish',
'enum' => array_keys( get_post_statuses() ),
'context' => array( 'view', 'edit' ),
),
'featured' => array(
'description' => __( 'Featured product.', 'woocommerce' ),
'type' => 'boolean',
'default' => false,
'context' => array( 'view', 'edit' ),
),
'catalog_visibility' => array(
'description' => __( 'Catalog visibility.', 'woocommerce' ),
'type' => 'string',
'default' => 'visible',
'enum' => array( 'visible', 'catalog', 'search', 'hidden' ),
'context' => array( 'view', 'edit' ),
),
'description' => array(
'description' => __( 'Product description.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'short_description' => array(
'description' => __( 'Product short description.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'sku' => array(
'description' => __( 'Unique identifier.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'price' => array(
'description' => __( 'Current product price.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'regular_price' => array(
'description' => __( 'Product regular price.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'sale_price' => array(
'description' => __( 'Product sale price.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'date_on_sale_from' => array(
'description' => __( 'Start date of sale price.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'date_on_sale_to' => array(
'description' => __( 'End data of sale price.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'price_html' => array(
'description' => __( 'Price formatted in HTML.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'on_sale' => array(
'description' => __( 'Shows if the product is on sale.', 'woocommerce' ),
'type' => 'boolean',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'purchasable' => array(
'description' => __( 'Shows if the product can be bought.', 'woocommerce' ),
'type' => 'boolean',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'total_sales' => array(
'description' => __( 'Amount of sales.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'virtual' => array(
'description' => __( 'If the product is virtual.', 'woocommerce' ),
'type' => 'boolean',
'default' => false,
'context' => array( 'view', 'edit' ),
),
'downloadable' => array(
'description' => __( 'If the product is downloadable.', 'woocommerce' ),
'type' => 'boolean',
'default' => false,
'context' => array( 'view', 'edit' ),
),
'downloads' => array(
'description' => __( 'List of downloadable files.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'File MD5 hash.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'name' => array(
'description' => __( 'File name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'file' => array(
'description' => __( 'File URL.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
),
),
),
'download_limit' => array(
'description' => __( 'Amount of times the product can be downloaded.', 'woocommerce' ),
'type' => 'integer',
'default' => -1,
'context' => array( 'view', 'edit' ),
),
'download_expiry' => array(
'description' => __( 'Number of days that the customer has up to be able to download the product.', 'woocommerce' ),
'type' => 'integer',
'default' => -1,
'context' => array( 'view', 'edit' ),
),
'download_type' => array(
'description' => __( 'Download type, this controls the schema on the front-end.', 'woocommerce' ),
'type' => 'string',
'default' => 'standard',
2017-02-13 21:44:27 +00:00
'enum' => array( 'standard' ),
'context' => array( 'view' ),
2017-02-09 20:40:35 +00:00
),
'external_url' => array(
'description' => __( 'Product external URL. Only for external products.', 'woocommerce' ),
'type' => 'string',
'format' => 'uri',
'context' => array( 'view', 'edit' ),
),
'button_text' => array(
'description' => __( 'Product external button text. Only for external products.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'tax_status' => array(
'description' => __( 'Tax status.', 'woocommerce' ),
'type' => 'string',
'default' => 'taxable',
'enum' => array( 'taxable', 'shipping', 'none' ),
'context' => array( 'view', 'edit' ),
),
'tax_class' => array(
'description' => __( 'Tax class.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'manage_stock' => array(
'description' => __( 'Stock management at product level.', 'woocommerce' ),
'type' => 'boolean',
'default' => false,
'context' => array( 'view', 'edit' ),
),
'stock_quantity' => array(
'description' => __( 'Stock quantity.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
),
'in_stock' => array(
'description' => __( 'Controls whether or not the product is listed as "in stock" or "out of stock" on the frontend.', 'woocommerce' ),
'type' => 'boolean',
'default' => true,
'context' => array( 'view', 'edit' ),
),
'backorders' => array(
'description' => __( 'If managing stock, this controls if backorders are allowed.', 'woocommerce' ),
'type' => 'string',
'default' => 'no',
'enum' => array( 'no', 'notify', 'yes' ),
'context' => array( 'view', 'edit' ),
),
'backorders_allowed' => array(
'description' => __( 'Shows if backorders are allowed.', 'woocommerce' ),
'type' => 'boolean',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'backordered' => array(
'description' => __( 'Shows if the product is on backordered.', 'woocommerce' ),
'type' => 'boolean',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'sold_individually' => array(
'description' => __( 'Allow one item to be bought in a single order.', 'woocommerce' ),
'type' => 'boolean',
'default' => false,
'context' => array( 'view', 'edit' ),
),
'weight' => array(
2017-02-13 21:44:27 +00:00
/* translators: %s: weight unit */
2017-02-09 20:40:35 +00:00
'description' => sprintf( __( 'Product weight (%s).', 'woocommerce' ), $weight_unit ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'dimensions' => array(
'description' => __( 'Product dimensions.', 'woocommerce' ),
'type' => 'object',
'context' => array( 'view', 'edit' ),
'properties' => array(
'length' => array(
2017-02-13 21:44:27 +00:00
/* translators: %s: dimension unit */
2017-02-09 20:40:35 +00:00
'description' => sprintf( __( 'Product length (%s).', 'woocommerce' ), $dimension_unit ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'width' => array(
2017-02-13 21:44:27 +00:00
/* translators: %s: dimension unit */
2017-02-09 20:40:35 +00:00
'description' => sprintf( __( 'Product width (%s).', 'woocommerce' ), $dimension_unit ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'height' => array(
2017-02-13 21:44:27 +00:00
/* translators: %s: dimension unit */
2017-02-09 20:40:35 +00:00
'description' => sprintf( __( 'Product height (%s).', 'woocommerce' ), $dimension_unit ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
),
),
'shipping_required' => array(
'description' => __( 'Shows if the product need to be shipped.', 'woocommerce' ),
'type' => 'boolean',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'shipping_taxable' => array(
'description' => __( 'Shows whether or not the product shipping is taxable.', 'woocommerce' ),
'type' => 'boolean',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'shipping_class' => array(
'description' => __( 'Shipping class slug.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'shipping_class_id' => array(
'description' => __( 'Shipping class ID.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'reviews_allowed' => array(
'description' => __( 'Allow reviews.', 'woocommerce' ),
'type' => 'boolean',
'default' => true,
'context' => array( 'view', 'edit' ),
),
'average_rating' => array(
'description' => __( 'Reviews average rating.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'rating_count' => array(
'description' => __( 'Amount of reviews that the product have.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'related_ids' => array(
'description' => __( 'List of related products IDs.', 'woocommerce' ),
'type' => 'array',
'items' => array(
'type' => 'integer',
),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'upsell_ids' => array(
'description' => __( 'List of up-sell products IDs.', 'woocommerce' ),
'type' => 'array',
'items' => array(
'type' => 'integer',
),
'context' => array( 'view', 'edit' ),
),
'cross_sell_ids' => array(
'description' => __( 'List of cross-sell products IDs.', 'woocommerce' ),
'type' => 'array',
'items' => array(
'type' => 'integer',
),
'context' => array( 'view', 'edit' ),
),
'parent_id' => array(
'description' => __( 'Product parent ID.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
),
'purchase_note' => array(
'description' => __( 'Optional note to send the customer after purchase.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'categories' => array(
'description' => __( 'List of categories.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Category ID.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
),
'name' => array(
'description' => __( 'Category name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'slug' => array(
'description' => __( 'Category slug.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
),
'tags' => array(
'description' => __( 'List of tags.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Tag ID.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
),
'name' => array(
'description' => __( 'Tag name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'slug' => array(
'description' => __( 'Tag slug.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
),
'images' => array(
'description' => __( 'List of images.', 'woocommerce' ),
2017-02-13 21:44:27 +00:00
'type' => 'object',
2017-02-09 20:40:35 +00:00
'context' => array( 'view', 'edit' ),
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Image ID.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
),
'date_created' => array(
'description' => __( "The date the image was created, in the site's timezone.", 'woocommerce' ),
'type' => 'date-time',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'date_modified' => array(
'description' => __( "The date the image was last modified, in the site's timezone.", 'woocommerce' ),
'type' => 'date-time',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'src' => array(
'description' => __( 'Image URL.', 'woocommerce' ),
'type' => 'string',
'format' => 'uri',
'context' => array( 'view', 'edit' ),
),
'name' => array(
'description' => __( 'Image name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'alt' => array(
'description' => __( 'Image alternative text.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'position' => array(
'description' => __( 'Image position. 0 means that the image is featured.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
),
),
),
),
'attributes' => array(
'description' => __( 'List of attributes.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Attribute ID.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
),
'name' => array(
'description' => __( 'Attribute name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'position' => array(
'description' => __( 'Attribute position.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
),
'visible' => array(
2017-02-13 21:44:27 +00:00
'description' => __( "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", 'woocommerce' ),
2017-02-09 20:40:35 +00:00
'type' => 'boolean',
'default' => false,
'context' => array( 'view', 'edit' ),
),
'variation' => array(
'description' => __( 'Define if the attribute can be used as variation.', 'woocommerce' ),
'type' => 'boolean',
'default' => false,
'context' => array( 'view', 'edit' ),
),
'options' => array(
'description' => __( 'List of available term names of the attribute.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
),
),
),
),
'default_attributes' => array(
'description' => __( 'Defaults variation attributes.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Attribute ID.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
),
'name' => array(
'description' => __( 'Attribute name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'option' => array(
'description' => __( 'Selected attribute term name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
),
),
),
'variations' => array(
'description' => __( 'List of variations.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Variation ID.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'date_created' => array(
'description' => __( "The date the variation was created, in the site's timezone.", 'woocommerce' ),
'type' => 'date-time',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'date_modified' => array(
'description' => __( "The date the variation was last modified, in the site's timezone.", 'woocommerce' ),
'type' => 'date-time',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'permalink' => array(
'description' => __( 'Variation URL.', 'woocommerce' ),
'type' => 'string',
'format' => 'uri',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'sku' => array(
'description' => __( 'Unique identifier.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'price' => array(
'description' => __( 'Current variation price.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'regular_price' => array(
'description' => __( 'Variation regular price.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'sale_price' => array(
'description' => __( 'Variation sale price.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'date_on_sale_from' => array(
'description' => __( 'Start date of sale price.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'date_on_sale_to' => array(
'description' => __( 'End data of sale price.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'on_sale' => array(
'description' => __( 'Shows if the variation is on sale.', 'woocommerce' ),
'type' => 'boolean',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'purchasable' => array(
'description' => __( 'Shows if the variation can be bought.', 'woocommerce' ),
'type' => 'boolean',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'visible' => array(
'description' => __( 'If the variation is visible.', 'woocommerce' ),
'type' => 'boolean',
2017-02-13 21:44:27 +00:00
'context' => array( 'view', 'edit' ),
2017-02-09 20:40:35 +00:00
),
'virtual' => array(
'description' => __( 'If the variation is virtual.', 'woocommerce' ),
'type' => 'boolean',
'default' => false,
'context' => array( 'view', 'edit' ),
),
'downloadable' => array(
'description' => __( 'If the variation is downloadable.', 'woocommerce' ),
'type' => 'boolean',
'default' => false,
'context' => array( 'view', 'edit' ),
),
'downloads' => array(
'description' => __( 'List of downloadable files.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'File MD5 hash.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'name' => array(
'description' => __( 'File name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'file' => array(
'description' => __( 'File URL.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
),
),
),
'download_limit' => array(
'description' => __( 'Amount of times the variation can be downloaded.', 'woocommerce' ),
'type' => 'integer',
'default' => null,
'context' => array( 'view', 'edit' ),
),
'download_expiry' => array(
'description' => __( 'Number of days that the customer has up to be able to download the variation.', 'woocommerce' ),
'type' => 'integer',
'default' => null,
'context' => array( 'view', 'edit' ),
),
'tax_status' => array(
'description' => __( 'Tax status.', 'woocommerce' ),
'type' => 'string',
'default' => 'taxable',
'enum' => array( 'taxable', 'shipping', 'none' ),
'context' => array( 'view', 'edit' ),
),
'tax_class' => array(
'description' => __( 'Tax class.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'manage_stock' => array(
'description' => __( 'Stock management at variation level.', 'woocommerce' ),
'type' => 'boolean',
'default' => false,
'context' => array( 'view', 'edit' ),
),
'stock_quantity' => array(
'description' => __( 'Stock quantity.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
),
'in_stock' => array(
'description' => __( 'Controls whether or not the variation is listed as "in stock" or "out of stock" on the frontend.', 'woocommerce' ),
'type' => 'boolean',
'default' => true,
'context' => array( 'view', 'edit' ),
),
'backorders' => array(
'description' => __( 'If managing stock, this controls if backorders are allowed.', 'woocommerce' ),
'type' => 'string',
'default' => 'no',
'enum' => array( 'no', 'notify', 'yes' ),
'context' => array( 'view', 'edit' ),
),
'backorders_allowed' => array(
'description' => __( 'Shows if backorders are allowed.', 'woocommerce' ),
'type' => 'boolean',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'backordered' => array(
'description' => __( 'Shows if the variation is on backordered.', 'woocommerce' ),
'type' => 'boolean',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'weight' => array(
2017-02-13 21:44:27 +00:00
/* translators: %s: weight unit */
2017-02-09 20:40:35 +00:00
'description' => sprintf( __( 'Variation weight (%s).', 'woocommerce' ), $weight_unit ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'dimensions' => array(
'description' => __( 'Variation dimensions.', 'woocommerce' ),
'type' => 'object',
'context' => array( 'view', 'edit' ),
'properties' => array(
'length' => array(
2017-02-13 21:44:27 +00:00
/* translators: %s: dimension unit */
2017-02-09 20:40:35 +00:00
'description' => sprintf( __( 'Variation length (%s).', 'woocommerce' ), $dimension_unit ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'width' => array(
2017-02-13 21:44:27 +00:00
/* translators: %s: dimension unit */
2017-02-09 20:40:35 +00:00
'description' => sprintf( __( 'Variation width (%s).', 'woocommerce' ), $dimension_unit ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'height' => array(
2017-02-13 21:44:27 +00:00
/* translators: %s: dimension unit */
2017-02-09 20:40:35 +00:00
'description' => sprintf( __( 'Variation height (%s).', 'woocommerce' ), $dimension_unit ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
),
),
'shipping_class' => array(
'description' => __( 'Shipping class slug.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'shipping_class_id' => array(
'description' => __( 'Shipping class ID.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'image' => array(
'description' => __( 'Variation image data.', 'woocommerce' ),
'type' => 'object',
'context' => array( 'view', 'edit' ),
'properties' => array(
'id' => array(
'description' => __( 'Image ID.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
),
'date_created' => array(
'description' => __( "The date the image was created, in the site's timezone.", 'woocommerce' ),
'type' => 'date-time',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'date_modified' => array(
'description' => __( "The date the image was last modified, in the site's timezone.", 'woocommerce' ),
'type' => 'date-time',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'src' => array(
'description' => __( 'Image URL.', 'woocommerce' ),
'type' => 'string',
'format' => 'uri',
'context' => array( 'view', 'edit' ),
),
'name' => array(
'description' => __( 'Image name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'alt' => array(
'description' => __( 'Image alternative text.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'position' => array(
'description' => __( 'Image position. 0 means that the image is featured.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
),
),
),
'attributes' => array(
'description' => __( 'List of attributes.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Attribute ID.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
),
'name' => array(
'description' => __( 'Attribute name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'option' => array(
'description' => __( 'Selected attribute term name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
),
),
),
),
),
),
'grouped_products' => array(
'description' => __( 'List of grouped products ID.', 'woocommerce' ),
'type' => 'array',
'items' => array(
'type' => 'integer',
),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'menu_order' => array(
'description' => __( 'Menu order, used to custom sort products.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
),
),
);
return $this->add_additional_fields_schema( $schema );
}
/**
* Get the query params for collections of attachments.
*
* @return array
*/
public function get_collection_params() {
$params = parent::get_collection_params();
$params['slug'] = array(
2017-02-13 21:44:27 +00:00
'description' => __( 'Limit result set to products with a specific slug.', 'woocommerce' ),
2017-02-09 20:40:35 +00:00
'type' => 'string',
'validate_callback' => 'rest_validate_request_arg',
);
$params['status'] = array(
'default' => 'any',
'description' => __( 'Limit result set to products assigned a specific status.', 'woocommerce' ),
'type' => 'string',
'enum' => array_merge( array( 'any' ), array_keys( get_post_statuses() ) ),
'sanitize_callback' => 'sanitize_key',
'validate_callback' => 'rest_validate_request_arg',
);
$params['type'] = array(
'description' => __( 'Limit result set to products assigned a specific type.', 'woocommerce' ),
'type' => 'string',
'enum' => array_keys( wc_get_product_types() ),
'sanitize_callback' => 'sanitize_key',
'validate_callback' => 'rest_validate_request_arg',
);
$params['category'] = array(
2017-02-13 21:44:27 +00:00
'description' => __( 'Limit result set to products assigned a specific category ID.', 'woocommerce' ),
2017-02-09 20:40:35 +00:00
'type' => 'string',
2017-02-13 21:44:27 +00:00
'sanitize_callback' => 'wp_parse_id_list',
2017-02-09 20:40:35 +00:00
'validate_callback' => 'rest_validate_request_arg',
);
$params['tag'] = array(
2017-02-13 21:44:27 +00:00
'description' => __( 'Limit result set to products assigned a specific tag ID.', 'woocommerce' ),
2017-02-09 20:40:35 +00:00
'type' => 'string',
2017-02-13 21:44:27 +00:00
'sanitize_callback' => 'wp_parse_id_list',
2017-02-09 20:40:35 +00:00
'validate_callback' => 'rest_validate_request_arg',
);
$params['shipping_class'] = array(
2017-02-13 21:44:27 +00:00
'description' => __( 'Limit result set to products assigned a specific shipping class ID.', 'woocommerce' ),
2017-02-09 20:40:35 +00:00
'type' => 'string',
2017-02-13 21:44:27 +00:00
'sanitize_callback' => 'wp_parse_id_list',
2017-02-09 20:40:35 +00:00
'validate_callback' => 'rest_validate_request_arg',
);
$params['attribute'] = array(
'description' => __( 'Limit result set to products with a specific attribute.', 'woocommerce' ),
'type' => 'string',
'sanitize_callback' => 'sanitize_text_field',
'validate_callback' => 'rest_validate_request_arg',
);
$params['attribute_term'] = array(
2017-02-13 21:44:27 +00:00
'description' => __( 'Limit result set to products with a specific attribute term ID (required an assigned attribute).', 'woocommerce' ),
2017-02-09 20:40:35 +00:00
'type' => 'string',
2017-02-13 21:44:27 +00:00
'sanitize_callback' => 'wp_parse_id_list',
2017-02-09 20:40:35 +00:00
'validate_callback' => 'rest_validate_request_arg',
);
$params['sku'] = array(
'description' => __( 'Limit result set to products with a specific SKU.', 'woocommerce' ),
'type' => 'string',
'sanitize_callback' => 'sanitize_text_field',
'validate_callback' => 'rest_validate_request_arg',
);
return $params;
}
}