| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145 |
- <?php
- /**
- * REST API Products controller
- *
- * Handles requests to the /products endpoint.
- *
- * @package WooCommerce/API
- * @since 2.6.0
- */
- defined( 'ABSPATH' ) || exit;
- /**
- * REST API Products controller class.
- *
- * @package WooCommerce/API
- * @extends WC_REST_CRUD_Controller
- */
- class WC_REST_Products_Controller extends WC_REST_Legacy_Products_Controller {
- /**
- * Endpoint namespace.
- *
- * @var string
- */
- protected $namespace = 'wc/v2';
- /**
- * Route base.
- *
- * @var string
- */
- protected $rest_base = 'products';
- /**
- * Post type.
- *
- * @var string
- */
- protected $post_type = 'product';
- /**
- * If object is hierarchical.
- *
- * @var bool
- */
- protected $hierarchical = true;
- /**
- * Initialize product actions.
- */
- public function __construct() {
- add_action( "woocommerce_rest_insert_{$this->post_type}_object", 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 object.
- *
- * @since 3.0.0
- * @param int $id Object ID.
- * @return WC_Data
- */
- protected function get_object( $id ) {
- return wc_get_product( $id );
- }
- /**
- * Prepare a single product output for response.
- *
- * @since 3.0.0
- * @param WC_Data $object Object data.
- * @param WP_REST_Request $request Request object.
- * @return WP_REST_Response
- */
- public function prepare_object_for_response( $object, $request ) {
- $context = ! empty( $request['context'] ) ? $request['context'] : 'view';
- $data = $this->get_product_data( $object, $context );
- // Add variations to variable products.
- if ( $object->is_type( 'variable' ) && $object->has_child() ) {
- $data['variations'] = $object->get_children();
- }
- // Add grouped products data.
- if ( $object->is_type( 'grouped' ) && $object->has_child() ) {
- $data['grouped_products'] = $object->get_children();
- }
- $data = $this->add_additional_fields_to_object( $data, $request );
- $data = $this->filter_response_by_context( $data, $context );
- $response = rest_ensure_response( $data );
- $response->add_links( $this->prepare_links( $object, $request ) );
- /**
- * Filter the data for a response.
- *
- * The dynamic portion of the hook name, $this->post_type,
- * refers to object type being prepared for the response.
- *
- * @param WP_REST_Response $response The response object.
- * @param WC_Data $object Object data.
- * @param WP_REST_Request $request Request object.
- */
- return apply_filters( "woocommerce_rest_prepare_{$this->post_type}_object", $response, $object, $request );
- }
- /**
- * Prepare objects query.
- *
- * @since 3.0.0
- * @param WP_REST_Request $request Full details about the request.
- * @return array
- */
- protected function prepare_objects_query( $request ) {
- $args = parent::prepare_objects_query( $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 ] ) ) {
- $tax_query[] = array(
- 'taxonomy' => $taxonomy,
- 'field' => 'term_id',
- 'terms' => $request[ $key ],
- );
- }
- }
- // Filter product type by slug.
- if ( ! empty( $request['type'] ) ) {
- $tax_query[] = array(
- 'taxonomy' => 'product_type',
- 'field' => 'slug',
- 'terms' => $request['type'],
- );
- }
- // Filter by attribute and term.
- if ( ! empty( $request['attribute'] ) && ! empty( $request['attribute_term'] ) ) {
- if ( in_array( $request['attribute'], wc_get_attribute_taxonomy_names(), true ) ) {
- $tax_query[] = array(
- 'taxonomy' => $request['attribute'],
- 'field' => 'term_id',
- 'terms' => $request['attribute_term'],
- );
- }
- }
- if ( ! empty( $tax_query ) ) {
- $args['tax_query'] = $tax_query; // WPCS: slow query ok.
- }
- // Filter featured.
- if ( is_bool( $request['featured'] ) ) {
- $args['tax_query'][] = array(
- 'taxonomy' => 'product_visibility',
- 'field' => 'name',
- 'terms' => 'featured',
- 'operator' => true === $request['featured'] ? 'IN' : 'NOT IN',
- );
- }
- // Filter by sku.
- if ( ! empty( $request['sku'] ) ) {
- $skus = explode( ',', $request['sku'] );
- // Include the current string as a SKU too.
- if ( 1 < count( $skus ) ) {
- $skus[] = $request['sku'];
- }
- $args['meta_query'] = $this->add_meta_query( // WPCS: slow query ok.
- $args, array(
- 'key' => '_sku',
- 'value' => $skus,
- 'compare' => 'IN',
- )
- );
- }
- // Filter by tax class.
- if ( ! empty( $request['tax_class'] ) ) {
- $args['meta_query'] = $this->add_meta_query( // WPCS: slow query ok.
- $args, array(
- 'key' => '_tax_class',
- 'value' => 'standard' !== $request['tax_class'] ? $request['tax_class'] : '',
- )
- );
- }
- // Price filter.
- if ( ! empty( $request['min_price'] ) || ! empty( $request['max_price'] ) ) {
- $args['meta_query'] = $this->add_meta_query( $args, wc_get_min_max_price_meta_query( $request ) ); // WPCS: slow query ok.
- }
- // Filter product in stock or out of stock.
- if ( is_bool( $request['in_stock'] ) ) {
- $args['meta_query'] = $this->add_meta_query( // WPCS: slow query ok.
- $args, array(
- 'key' => '_stock_status',
- 'value' => true === $request['in_stock'] ? 'instock' : 'outofstock',
- )
- );
- }
- // Filter by on sale products.
- if ( is_bool( $request['on_sale'] ) ) {
- $on_sale_key = $request['on_sale'] ? 'post__in' : 'post__not_in';
- $on_sale_ids = wc_get_product_ids_on_sale();
- // Use 0 when there's no on sale products to avoid return all products.
- $on_sale_ids = empty( $on_sale_ids ) ? array( 0 ) : $on_sale_ids;
- $args[ $on_sale_key ] += $on_sale_ids;
- }
- // Force the post_type argument, since it's not a user input variable.
- if ( ! empty( $request['sku'] ) ) {
- $args['post_type'] = array( 'product', 'product_variation' );
- } else {
- $args['post_type'] = $this->post_type;
- }
- return $args;
- }
- /**
- * Get the downloads for a product or product variation.
- *
- * @param WC_Product|WC_Product_Variation $product Product instance.
- * @return array
- */
- protected function get_downloads( $product ) {
- $downloads = array();
- if ( $product->is_downloadable() ) {
- foreach ( $product->get_downloads() as $file_id => $file ) {
- $downloads[] = array(
- 'id' => $file_id, // MD5 hash.
- 'name' => $file['name'],
- 'file' => $file['file'],
- );
- }
- }
- return $downloads;
- }
- /**
- * Get taxonomy terms.
- *
- * @param WC_Product $product Product instance.
- * @param string $taxonomy Taxonomy slug.
- * @return array
- */
- protected function get_taxonomy_terms( $product, $taxonomy = 'cat' ) {
- $terms = array();
- foreach ( wc_get_object_terms( $product->get_id(), 'product_' . $taxonomy ) as $term ) {
- $terms[] = array(
- 'id' => $term->term_id,
- 'name' => $term->name,
- 'slug' => $term->slug,
- );
- }
- return $terms;
- }
- /**
- * Get the images for a product or product variation.
- *
- * @param WC_Product|WC_Product_Variation $product Product instance.
- * @return array
- */
- protected function get_images( $product ) {
- $images = array();
- $attachment_ids = array();
- // Add featured image.
- if ( has_post_thumbnail( $product->get_id() ) ) {
- $attachment_ids[] = $product->get_image_id();
- }
- // Add gallery images.
- $attachment_ids = array_merge( $attachment_ids, $product->get_gallery_image_ids() );
- // 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, false ),
- 'date_created_gmt' => wc_rest_prepare_date_response( strtotime( $attachment_post->post_date_gmt ) ),
- 'date_modified' => wc_rest_prepare_date_response( $attachment_post->post_modified, false ),
- 'date_modified_gmt' => wc_rest_prepare_date_response( strtotime( $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' ), false ), // Default to now.
- 'date_created_gmt' => wc_rest_prepare_date_response( current_time( 'timestamp', true ) ), // Default to now.
- 'date_modified' => wc_rest_prepare_date_response( current_time( 'mysql' ), false ),
- 'date_modified_gmt' => wc_rest_prepare_date_response( current_time( 'timestamp', true ) ),
- 'src' => wc_placeholder_img_src(),
- 'name' => __( 'Placeholder', 'woocommerce' ),
- 'alt' => __( 'Placeholder', 'woocommerce' ),
- 'position' => 0,
- );
- }
- return $images;
- }
- /**
- * Get attribute taxonomy label.
- *
- * @deprecated 3.0.0
- *
- * @param string $name Taxonomy name.
- * @return string
- */
- protected function get_attribute_taxonomy_label( $name ) {
- $tax = get_taxonomy( $name );
- $labels = get_taxonomy_labels( $tax );
- return $labels->singular_name;
- }
- /**
- * Get product attribute taxonomy name.
- *
- * @since 3.0.0
- * @param string $slug Taxonomy name.
- * @param WC_Product $product Product data.
- * @return string
- */
- protected function get_attribute_taxonomy_name( $slug, $product ) {
- $attributes = $product->get_attributes();
- if ( ! isset( $attributes[ $slug ] ) ) {
- return str_replace( 'pa_', '', $slug );
- }
- $attribute = $attributes[ $slug ];
- // Taxonomy attribute name.
- if ( $attribute->is_taxonomy() ) {
- $taxonomy = $attribute->get_taxonomy_object();
- return $taxonomy->attribute_label;
- }
- // Custom product attribute name.
- return $attribute->get_name();
- }
- /**
- * Get default attributes.
- *
- * @param WC_Product $product Product instance.
- * @return array
- */
- protected function get_default_attributes( $product ) {
- $default = array();
- if ( $product->is_type( 'variable' ) ) {
- foreach ( array_filter( (array) $product->get_default_attributes(), 'strlen' ) as $key => $value ) {
- if ( 0 === strpos( $key, 'pa_' ) ) {
- $default[] = array(
- 'id' => wc_attribute_taxonomy_id_by_name( $key ),
- 'name' => $this->get_attribute_taxonomy_name( $key, $product ),
- 'option' => $value,
- );
- } else {
- $default[] = array(
- 'id' => 0,
- 'name' => $this->get_attribute_taxonomy_name( $key, $product ),
- 'option' => $value,
- );
- }
- }
- }
- return $default;
- }
- /**
- * Get attribute options.
- *
- * @param int $product_id Product ID.
- * @param array $attribute Attribute data.
- * @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.
- *
- * @param WC_Product|WC_Product_Variation $product Product instance.
- * @return array
- */
- protected function get_attributes( $product ) {
- $attributes = array();
- if ( $product->is_type( 'variation' ) ) {
- $_product = wc_get_product( $product->get_parent_id() );
- 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_' ) ) {
- $option_term = get_term_by( 'slug', $attribute, $name );
- $attributes[] = array(
- 'id' => wc_attribute_taxonomy_id_by_name( $name ),
- 'name' => $this->get_attribute_taxonomy_name( $name, $_product ),
- 'option' => $option_term && ! is_wp_error( $option_term ) ? $option_term->name : $attribute,
- );
- } else {
- $attributes[] = array(
- 'id' => 0,
- 'name' => $this->get_attribute_taxonomy_name( $name, $_product ),
- 'option' => $attribute,
- );
- }
- }
- } else {
- foreach ( $product->get_attributes() as $attribute ) {
- $attributes[] = array(
- 'id' => $attribute['is_taxonomy'] ? wc_attribute_taxonomy_id_by_name( $attribute['name'] ) : 0,
- 'name' => $this->get_attribute_taxonomy_name( $attribute['name'], $product ),
- 'position' => (int) $attribute['position'],
- 'visible' => (bool) $attribute['is_visible'],
- 'variation' => (bool) $attribute['is_variation'],
- 'options' => $this->get_attribute_options( $product->get_id(), $attribute ),
- );
- }
- }
- return $attributes;
- }
- /**
- * Get product data.
- *
- * @param WC_Product $product Product instance.
- * @param string $context Request context.
- * Options: 'view' and 'edit'.
- * @return array
- */
- protected function get_product_data( $product, $context = 'view' ) {
- $data = array(
- 'id' => $product->get_id(),
- 'name' => $product->get_name( $context ),
- 'slug' => $product->get_slug( $context ),
- 'permalink' => $product->get_permalink(),
- 'date_created' => wc_rest_prepare_date_response( $product->get_date_created( $context ), false ),
- 'date_created_gmt' => wc_rest_prepare_date_response( $product->get_date_created( $context ) ),
- 'date_modified' => wc_rest_prepare_date_response( $product->get_date_modified( $context ), false ),
- 'date_modified_gmt' => wc_rest_prepare_date_response( $product->get_date_modified( $context ) ),
- 'type' => $product->get_type(),
- 'status' => $product->get_status( $context ),
- 'featured' => $product->is_featured(),
- 'catalog_visibility' => $product->get_catalog_visibility( $context ),
- 'description' => 'view' === $context ? wpautop( do_shortcode( $product->get_description() ) ) : $product->get_description( $context ),
- 'short_description' => 'view' === $context ? apply_filters( 'woocommerce_short_description', $product->get_short_description() ) : $product->get_short_description( $context ),
- 'sku' => $product->get_sku( $context ),
- 'price' => $product->get_price( $context ),
- 'regular_price' => $product->get_regular_price( $context ),
- 'sale_price' => $product->get_sale_price( $context ) ? $product->get_sale_price( $context ) : '',
- 'date_on_sale_from' => wc_rest_prepare_date_response( $product->get_date_on_sale_from( $context ), false ),
- 'date_on_sale_from_gmt' => wc_rest_prepare_date_response( $product->get_date_on_sale_from( $context ) ),
- 'date_on_sale_to' => wc_rest_prepare_date_response( $product->get_date_on_sale_to( $context ), false ),
- 'date_on_sale_to_gmt' => wc_rest_prepare_date_response( $product->get_date_on_sale_to( $context ) ),
- 'price_html' => $product->get_price_html(),
- 'on_sale' => $product->is_on_sale( $context ),
- 'purchasable' => $product->is_purchasable(),
- 'total_sales' => $product->get_total_sales( $context ),
- 'virtual' => $product->is_virtual(),
- 'downloadable' => $product->is_downloadable(),
- 'downloads' => $this->get_downloads( $product ),
- 'download_limit' => $product->get_download_limit( $context ),
- 'download_expiry' => $product->get_download_expiry( $context ),
- 'external_url' => $product->is_type( 'external' ) ? $product->get_product_url( $context ) : '',
- 'button_text' => $product->is_type( 'external' ) ? $product->get_button_text( $context ) : '',
- 'tax_status' => $product->get_tax_status( $context ),
- 'tax_class' => $product->get_tax_class( $context ),
- 'manage_stock' => $product->managing_stock(),
- 'stock_quantity' => $product->get_stock_quantity( $context ),
- 'in_stock' => $product->is_in_stock(),
- 'backorders' => $product->get_backorders( $context ),
- 'backorders_allowed' => $product->backorders_allowed(),
- 'backordered' => $product->is_on_backorder(),
- 'sold_individually' => $product->is_sold_individually(),
- 'weight' => $product->get_weight( $context ),
- 'dimensions' => array(
- 'length' => $product->get_length( $context ),
- 'width' => $product->get_width( $context ),
- 'height' => $product->get_height( $context ),
- ),
- 'shipping_required' => $product->needs_shipping(),
- 'shipping_taxable' => $product->is_shipping_taxable(),
- 'shipping_class' => $product->get_shipping_class(),
- 'shipping_class_id' => $product->get_shipping_class_id( $context ),
- 'reviews_allowed' => $product->get_reviews_allowed( $context ),
- 'average_rating' => 'view' === $context ? wc_format_decimal( $product->get_average_rating(), 2 ) : $product->get_average_rating( $context ),
- '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( $context ) ),
- 'cross_sell_ids' => array_map( 'absint', $product->get_cross_sell_ids( $context ) ),
- 'parent_id' => $product->get_parent_id( $context ),
- 'purchase_note' => 'view' === $context ? wpautop( do_shortcode( wp_kses_post( $product->get_purchase_note() ) ) ) : $product->get_purchase_note( $context ),
- '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(),
- 'menu_order' => $product->get_menu_order( $context ),
- 'meta_data' => $product->get_meta_data(),
- );
- return $data;
- }
- /**
- * Prepare links for the request.
- *
- * @param WC_Data $object Object data.
- * @param WP_REST_Request $request Request object.
- * @return array Links for the given post.
- */
- protected function prepare_links( $object, $request ) {
- $links = array(
- 'self' => array(
- 'href' => rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $object->get_id() ) ),
- ),
- 'collection' => array(
- 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
- ),
- );
- if ( $object->get_parent_id() ) {
- $links['up'] = array(
- 'href' => rest_url( sprintf( '/%s/products/%d', $this->namespace, $object->get_parent_id() ) ),
- );
- }
- return $links;
- }
- /**
- * Prepare a single product for create or update.
- *
- * @param WP_REST_Request $request Request object.
- * @param bool $creating If is creating a new object.
- * @return WP_Error|WC_Data
- */
- protected function prepare_object_for_database( $request, $creating = false ) {
- $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'] );
- 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();
- }
- if ( 'variation' === $product->get_type() ) {
- return new WP_Error(
- "woocommerce_rest_invalid_{$this->post_type}_id", __( 'To manipulate product variations you should use the /products/<product_id>/variations/<id> endpoint.', 'woocommerce' ), array(
- 'status' => 404,
- )
- );
- }
- // Post title.
- if ( isset( $request['name'] ) ) {
- $product->set_name( wp_filter_post_kses( $request['name'] ) );
- }
- // Post content.
- if ( isset( $request['description'] ) ) {
- $product->set_description( wp_filter_post_kses( $request['description'] ) );
- }
- // Post excerpt.
- if ( isset( $request['short_description'] ) ) {
- $product->set_short_description( wp_filter_post_kses( $request['short_description'] ) );
- }
- // Post status.
- if ( isset( $request['status'] ) ) {
- $product->set_status( get_post_status_object( $request['status'] ) ? $request['status'] : 'draft' );
- }
- // Post slug.
- if ( isset( $request['slug'] ) ) {
- $product->set_slug( $request['slug'] );
- }
- // Menu order.
- if ( isset( $request['menu_order'] ) ) {
- $product->set_menu_order( $request['menu_order'] );
- }
- // Comment status.
- if ( isset( $request['reviews_allowed'] ) ) {
- $product->set_reviews_allowed( $request['reviews_allowed'] );
- }
- // Virtual.
- if ( isset( $request['virtual'] ) ) {
- $product->set_virtual( $request['virtual'] );
- }
- // Tax status.
- if ( isset( $request['tax_status'] ) ) {
- $product->set_tax_status( $request['tax_status'] );
- }
- // Tax Class.
- if ( isset( $request['tax_class'] ) ) {
- $product->set_tax_class( $request['tax_class'] );
- }
- // Catalog Visibility.
- if ( isset( $request['catalog_visibility'] ) ) {
- $product->set_catalog_visibility( $request['catalog_visibility'] );
- }
- // Purchase Note.
- if ( isset( $request['purchase_note'] ) ) {
- $product->set_purchase_note( wp_kses_post( wp_unslash( $request['purchase_note'] ) ) );
- }
- // Featured Product.
- if ( isset( $request['featured'] ) ) {
- $product->set_featured( $request['featured'] );
- }
- // Shipping data.
- $product = $this->save_product_shipping_data( $product, $request );
- // SKU.
- if ( isset( $request['sku'] ) ) {
- $product->set_sku( wc_clean( $request['sku'] ) );
- }
- // 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.
- $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;
- }
- } elseif ( isset( $attribute['options'] ) ) {
- // Custom attribute - Add attribute to array and set the values.
- if ( is_array( $attribute['options'] ) ) {
- $values = $attribute['options'];
- } else {
- $values = explode( WC_DELIMITER, $attribute['options'] );
- }
- $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;
- }
- }
- $product->set_attributes( $attributes );
- }
- // Sales and prices.
- 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( '' );
- } else {
- // Regular Price.
- if ( isset( $request['regular_price'] ) ) {
- $product->set_regular_price( $request['regular_price'] );
- }
- // Sale Price.
- if ( isset( $request['sale_price'] ) ) {
- $product->set_sale_price( $request['sale_price'] );
- }
- if ( isset( $request['date_on_sale_from'] ) ) {
- $product->set_date_on_sale_from( $request['date_on_sale_from'] );
- }
- if ( isset( $request['date_on_sale_from_gmt'] ) ) {
- $product->set_date_on_sale_from( $request['date_on_sale_from_gmt'] ? strtotime( $request['date_on_sale_from_gmt'] ) : null );
- }
- if ( isset( $request['date_on_sale_to'] ) ) {
- $product->set_date_on_sale_to( $request['date_on_sale_to'] );
- }
- if ( isset( $request['date_on_sale_to_gmt'] ) ) {
- $product->set_date_on_sale_to( $request['date_on_sale_to_gmt'] ? strtotime( $request['date_on_sale_to_gmt'] ) : null );
- }
- }
- // Product parent ID for groups.
- if ( isset( $request['parent_id'] ) ) {
- $product->set_parent_id( $request['parent_id'] );
- }
- // Sold individually.
- if ( isset( $request['sold_individually'] ) ) {
- $product->set_sold_individually( $request['sold_individually'] );
- }
- // Stock status.
- if ( isset( $request['in_stock'] ) ) {
- $stock_status = true === $request['in_stock'] ? 'instock' : 'outofstock';
- } else {
- $stock_status = $product->get_stock_status();
- }
- // Stock data.
- if ( 'yes' === get_option( 'woocommerce_manage_stock' ) ) {
- // Manage stock.
- if ( isset( $request['manage_stock'] ) ) {
- $product->set_manage_stock( $request['manage_stock'] );
- }
- // Backorders.
- if ( isset( $request['backorders'] ) ) {
- $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() ) {
- // Stock status is always determined by children so sync later.
- if ( ! $product->is_type( 'variable' ) ) {
- $product->set_stock_status( $stock_status );
- }
- // Stock quantity.
- if ( isset( $request['stock_quantity'] ) ) {
- $product->set_stock_quantity( wc_stock_amount( $request['stock_quantity'] ) );
- } elseif ( isset( $request['inventory_delta'] ) ) {
- $stock_quantity = wc_stock_amount( $product->get_stock_quantity() );
- $stock_quantity += wc_stock_amount( $request['inventory_delta'] );
- $product->set_stock_quantity( wc_stock_amount( $stock_quantity ) );
- }
- } else {
- // Don't manage stock.
- $product->set_manage_stock( 'no' );
- $product->set_stock_quantity( '' );
- $product->set_stock_status( $stock_status );
- }
- } elseif ( ! $product->is_type( 'variable' ) ) {
- $product->set_stock_status( $stock_status );
- }
- // 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;
- }
- }
- }
- $product->set_upsell_ids( $upsells );
- }
- // 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;
- }
- }
- }
- $product->set_cross_sell_ids( $crosssells );
- }
- // Product categories.
- if ( isset( $request['categories'] ) && is_array( $request['categories'] ) ) {
- $product = $this->save_taxonomy_terms( $product, $request['categories'] );
- }
- // Product tags.
- if ( isset( $request['tags'] ) && is_array( $request['tags'] ) ) {
- $product = $this->save_taxonomy_terms( $product, $request['tags'], 'tag' );
- }
- // Downloadable.
- if ( isset( $request['downloadable'] ) ) {
- $product->set_downloadable( $request['downloadable'] );
- }
- // Downloadable options.
- if ( $product->get_downloadable() ) {
- // Downloadable files.
- if ( isset( $request['downloads'] ) && is_array( $request['downloads'] ) ) {
- $product = $this->save_downloadable_files( $product, $request['downloads'] );
- }
- // Download limit.
- if ( isset( $request['download_limit'] ) ) {
- $product->set_download_limit( $request['download_limit'] );
- }
- // Download expiry.
- if ( isset( $request['download_expiry'] ) ) {
- $product->set_download_expiry( $request['download_expiry'] );
- }
- }
- // Product url and button text for external products.
- if ( $product->is_type( 'external' ) ) {
- if ( isset( $request['external_url'] ) ) {
- $product->set_product_url( $request['external_url'] );
- }
- if ( isset( $request['button_text'] ) ) {
- $product->set_button_text( $request['button_text'] );
- }
- }
- // Save default attributes for variable products.
- if ( $product->is_type( 'variable' ) ) {
- $product = $this->save_default_attributes( $product, $request );
- }
- // Set children for a grouped product.
- if ( $product->is_type( 'grouped' ) && isset( $request['grouped_products'] ) ) {
- $product->set_children( $request['grouped_products'] );
- }
- // Check for featured/gallery images, upload it and set it.
- if ( isset( $request['images'] ) ) {
- $product = $this->set_product_images( $product, $request['images'] );
- }
- // Allow set meta_data.
- if ( is_array( $request['meta_data'] ) ) {
- foreach ( $request['meta_data'] as $meta ) {
- $product->update_meta_data( $meta['key'], $meta['value'], isset( $meta['id'] ) ? $meta['id'] : '' );
- }
- }
- /**
- * Filters an object before it is inserted via the REST API.
- *
- * The dynamic portion of the hook name, `$this->post_type`,
- * refers to the object type slug.
- *
- * @param WC_Data $product Object object.
- * @param WP_REST_Request $request Request object.
- * @param bool $creating If is creating a new object.
- */
- return apply_filters( "woocommerce_rest_pre_insert_{$this->post_type}_object", $product, $request, $creating );
- }
- /**
- * 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 ) {
- $images = is_array( $images ) ? array_filter( $images ) : array();
- if ( ! empty( $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 ) ) {
- 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;
- }
- }
- $attachment_id = wc_rest_set_uploaded_image_as_attachment( $upload, $product->get_id() );
- }
- if ( ! wp_attachment_is_image( $attachment_id ) ) {
- /* translators: %s: 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'] ) ) {
- $product->set_image_id( $attachment_id );
- } 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'],
- )
- );
- }
- // Set the image source if present, for future reference.
- if ( ! empty( $image['src'] ) ) {
- update_post_meta( $attachment_id, '_wc_attachment_source', esc_url_raw( $image['src'] ) );
- }
- }
- $product->set_gallery_image_ids( $gallery );
- } else {
- $product->set_image_id( '' );
- $product->set_gallery_image_ids( array() );
- }
- return $product;
- }
- /**
- * Save product shipping data.
- *
- * @param WC_Product $product Product instance.
- * @param array $data Shipping data.
- * @return WC_Product
- */
- protected function save_product_shipping_data( $product, $data ) {
- // Virtual.
- if ( isset( $data['virtual'] ) && true === $data['virtual'] ) {
- $product->set_weight( '' );
- $product->set_height( '' );
- $product->set_length( '' );
- $product->set_width( '' );
- } else {
- if ( isset( $data['weight'] ) ) {
- $product->set_weight( $data['weight'] );
- }
- // Height.
- if ( isset( $data['dimensions']['height'] ) ) {
- $product->set_height( $data['dimensions']['height'] );
- }
- // Width.
- if ( isset( $data['dimensions']['width'] ) ) {
- $product->set_width( $data['dimensions']['width'] );
- }
- // Length.
- if ( isset( $data['dimensions']['length'] ) ) {
- $product->set_length( $data['dimensions']['length'] );
- }
- }
- // Shipping class.
- if ( isset( $data['shipping_class'] ) ) {
- $data_store = $product->get_data_store();
- $shipping_class_id = $data_store->get_shipping_class_id_by_slug( wc_clean( $data['shipping_class'] ) );
- $product->set_shipping_class_id( $shipping_class_id );
- }
- return $product;
- }
- /**
- * Save downloadable files.
- *
- * @param WC_Product $product Product instance.
- * @param array $downloads Downloads data.
- * @param int $deprecated Deprecated since 3.0.
- * @return WC_Product
- */
- protected function save_downloadable_files( $product, $downloads, $deprecated = 0 ) {
- if ( $deprecated ) {
- wc_deprecated_argument( 'variation_id', '3.0', 'save_downloadable_files() not requires a variation_id anymore.' );
- }
- $files = array();
- foreach ( $downloads as $key => $file ) {
- if ( empty( $file['file'] ) ) {
- continue;
- }
- $download = new WC_Product_Download();
- $download->set_id( $file['id'] ? $file['id'] : wp_generate_uuid4() );
- $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;
- }
- $product->set_downloads( $files );
- return $product;
- }
- /**
- * Save taxonomy terms.
- *
- * @param WC_Product $product Product instance.
- * @param array $terms Terms data.
- * @param string $taxonomy Taxonomy name.
- * @return WC_Product
- */
- protected function save_taxonomy_terms( $product, $terms, $taxonomy = 'cat' ) {
- $term_ids = wp_list_pluck( $terms, 'id' );
- if ( 'cat' === $taxonomy ) {
- $product->set_category_ids( $term_ids );
- } elseif ( 'tag' === $taxonomy ) {
- $product->set_tag_ids( $term_ids );
- }
- return $product;
- }
- /**
- * Save default attributes.
- *
- * @since 3.0.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_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;
- }
- /**
- * Clear caches here so in sync with any new variations/children.
- *
- * @param WC_Data $object Object data.
- */
- public function clear_transients( $object ) {
- wc_delete_product_transients( $object->get_id() );
- wp_cache_delete( 'product-' . $object->get_id(), 'products' );
- }
- /**
- * 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 ) {
- $id = (int) $request['id'];
- $force = (bool) $request['force'];
- $object = $this->get_object( (int) $request['id'] );
- $result = false;
- if ( ! $object || 0 === $object->get_id() ) {
- return new WP_Error(
- "woocommerce_rest_{$this->post_type}_invalid_id", __( 'Invalid ID.', 'woocommerce' ), array(
- 'status' => 404,
- )
- );
- }
- if ( 'variation' === $object->get_type() ) {
- return new WP_Error(
- "woocommerce_rest_invalid_{$this->post_type}_id", __( 'To manipulate product variations you should use the /products/<product_id>/variations/<id> endpoint.', 'woocommerce' ), array(
- 'status' => 404,
- )
- );
- }
- $supports_trash = EMPTY_TRASH_DAYS > 0 && is_callable( array( $object, 'get_status' ) );
- /**
- * Filter whether an object is trashable.
- *
- * Return false to disable trash support for the object.
- *
- * @param boolean $supports_trash Whether the object type support trashing.
- * @param WC_Data $object The object being considered for trashing support.
- */
- $supports_trash = apply_filters( "woocommerce_rest_{$this->post_type}_object_trashable", $supports_trash, $object );
- if ( ! wc_rest_check_post_permissions( $this->post_type, 'delete', $object->get_id() ) ) {
- return new WP_Error(
- /* translators: %s: post type */
- "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_object_for_response( $object, $request );
- // If we're forcing, then delete permanently.
- if ( $force ) {
- if ( $object->is_type( 'variable' ) ) {
- foreach ( $object->get_children() as $child_id ) {
- $child = wc_get_product( $child_id );
- $child->delete( true );
- }
- } elseif ( $object->is_type( 'grouped' ) ) {
- foreach ( $object->get_children() as $child_id ) {
- $child = wc_get_product( $child_id );
- $child->set_parent_id( 0 );
- $child->save();
- }
- }
- $object->delete( true );
- $result = 0 === $object->get_id();
- } else {
- // If we don't support trashing for this type, error out.
- if ( ! $supports_trash ) {
- return new WP_Error(
- /* translators: %s: post type */
- '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 ( is_callable( array( $object, 'get_status' ) ) ) {
- if ( 'trash' === $object->get_status() ) {
- return new WP_Error(
- /* translators: %s: post type */
- 'woocommerce_rest_already_trashed', sprintf( __( 'The %s has already been deleted.', 'woocommerce' ), $this->post_type ), array(
- 'status' => 410,
- )
- );
- }
- $object->delete();
- $result = 'trash' === $object->get_status();
- }
- }
- if ( ! $result ) {
- return new WP_Error(
- /* translators: %s: post type */
- 'woocommerce_rest_cannot_delete', sprintf( __( 'The %s cannot be deleted.', 'woocommerce' ), $this->post_type ), array(
- 'status' => 500,
- )
- );
- }
- // Delete parent product transients.
- if ( 0 !== $object->get_parent_id() ) {
- wc_delete_product_transients( $object->get_parent_id() );
- }
- /**
- * Fires after a single object is deleted or trashed via the REST API.
- *
- * @param WC_Data $object The deleted or trashed object.
- * @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}_object", $object, $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_created_gmt' => array(
- 'description' => __( 'The date the product was created, as GMT.', '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,
- ),
- 'date_modified_gmt' => array(
- 'description' => __( 'The date the product was last modified, as GMT.', '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, in the site's timezone.", 'woocommerce' ),
- 'type' => 'date-time',
- 'context' => array( 'view', 'edit' ),
- ),
- 'date_on_sale_from_gmt' => array(
- 'description' => __( 'Start date of sale price, as GMT.', 'woocommerce' ),
- 'type' => 'date-time',
- 'context' => array( 'view', 'edit' ),
- ),
- 'date_on_sale_to' => array(
- 'description' => __( "End date of sale price, in the site's timezone.", 'woocommerce' ),
- 'type' => 'date-time',
- 'context' => array( 'view', 'edit' ),
- ),
- 'date_on_sale_to_gmt' => array(
- 'description' => __( 'End date of sale price, as GMT.', 'woocommerce' ),
- 'type' => 'date-time',
- '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' => __( 'Number of times downloadable files can be downloaded after purchase.', 'woocommerce' ),
- 'type' => 'integer',
- 'default' => -1,
- 'context' => array( 'view', 'edit' ),
- ),
- 'download_expiry' => array(
- 'description' => __( 'Number of days until access to downloadable files expires.', 'woocommerce' ),
- 'type' => 'integer',
- 'default' => -1,
- 'context' => array( 'view', 'edit' ),
- ),
- '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(
- /* translators: %s: weight unit */
- '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(
- /* translators: %s: dimension unit */
- 'description' => sprintf( __( 'Product length (%s).', 'woocommerce' ), $dimension_unit ),
- 'type' => 'string',
- 'context' => array( 'view', 'edit' ),
- ),
- 'width' => array(
- /* translators: %s: dimension unit */
- 'description' => sprintf( __( 'Product width (%s).', 'woocommerce' ), $dimension_unit ),
- 'type' => 'string',
- 'context' => array( 'view', 'edit' ),
- ),
- 'height' => array(
- /* translators: %s: dimension unit */
- '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' => 'integer',
- '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' ),
- 'type' => 'array',
- '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_created_gmt' => array(
- 'description' => __( 'The date the image was created, as GMT.', '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,
- ),
- 'date_modified_gmt' => array(
- 'description' => __( 'The date the image was last modified, as GMT.', '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(
- 'description' => __( "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", 'woocommerce' ),
- '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' ),
- 'items' => array(
- 'type' => 'string',
- ),
- ),
- ),
- ),
- ),
- '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 IDs.', 'woocommerce' ),
- 'type' => 'array',
- 'context' => array( 'view', 'edit' ),
- 'items' => array(
- 'type' => 'integer',
- ),
- 'readonly' => true,
- ),
- 'grouped_products' => array(
- 'description' => __( 'List of grouped products ID.', 'woocommerce' ),
- 'type' => 'array',
- 'items' => array(
- 'type' => 'integer',
- ),
- 'context' => array( 'view', 'edit' ),
- ),
- 'menu_order' => array(
- 'description' => __( 'Menu order, used to custom sort products.', 'woocommerce' ),
- 'type' => 'integer',
- 'context' => array( 'view', 'edit' ),
- ),
- 'meta_data' => array(
- 'description' => __( 'Meta data.', 'woocommerce' ),
- 'type' => 'array',
- 'context' => array( 'view', 'edit' ),
- 'items' => array(
- 'type' => 'object',
- 'properties' => array(
- 'id' => array(
- 'description' => __( 'Meta ID.', 'woocommerce' ),
- 'type' => 'integer',
- 'context' => array( 'view', 'edit' ),
- 'readonly' => true,
- ),
- 'key' => array(
- 'description' => __( 'Meta key.', 'woocommerce' ),
- 'type' => 'string',
- 'context' => array( 'view', 'edit' ),
- ),
- 'value' => array(
- 'description' => __( 'Meta value.', 'woocommerce' ),
- 'type' => 'mixed',
- '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(
- 'description' => __( 'Limit result set to products with a specific slug.', 'woocommerce' ),
- '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['sku'] = array(
- 'description' => __( 'Limit result set to products with specific SKU(s). Use commas to separate.', 'woocommerce' ),
- 'type' => 'string',
- 'sanitize_callback' => 'sanitize_text_field',
- 'validate_callback' => 'rest_validate_request_arg',
- );
- $params['featured'] = array(
- 'description' => __( 'Limit result set to featured products.', 'woocommerce' ),
- 'type' => 'boolean',
- 'sanitize_callback' => 'wc_string_to_bool',
- 'validate_callback' => 'rest_validate_request_arg',
- );
- $params['category'] = array(
- 'description' => __( 'Limit result set to products assigned a specific category ID.', 'woocommerce' ),
- 'type' => 'string',
- 'sanitize_callback' => 'wp_parse_id_list',
- 'validate_callback' => 'rest_validate_request_arg',
- );
- $params['tag'] = array(
- 'description' => __( 'Limit result set to products assigned a specific tag ID.', 'woocommerce' ),
- 'type' => 'string',
- 'sanitize_callback' => 'wp_parse_id_list',
- 'validate_callback' => 'rest_validate_request_arg',
- );
- $params['shipping_class'] = array(
- 'description' => __( 'Limit result set to products assigned a specific shipping class ID.', 'woocommerce' ),
- 'type' => 'string',
- 'sanitize_callback' => 'wp_parse_id_list',
- 'validate_callback' => 'rest_validate_request_arg',
- );
- $params['attribute'] = array(
- 'description' => __( 'Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.', 'woocommerce' ),
- 'type' => 'string',
- 'sanitize_callback' => 'sanitize_text_field',
- 'validate_callback' => 'rest_validate_request_arg',
- );
- $params['attribute_term'] = array(
- 'description' => __( 'Limit result set to products with a specific attribute term ID (required an assigned attribute).', 'woocommerce' ),
- 'type' => 'string',
- 'sanitize_callback' => 'wp_parse_id_list',
- 'validate_callback' => 'rest_validate_request_arg',
- );
- if ( wc_tax_enabled() ) {
- $params['tax_class'] = array(
- 'description' => __( 'Limit result set to products with a specific tax class.', 'woocommerce' ),
- 'type' => 'string',
- 'enum' => array_merge( array( 'standard' ), WC_Tax::get_tax_class_slugs() ),
- 'sanitize_callback' => 'sanitize_text_field',
- 'validate_callback' => 'rest_validate_request_arg',
- );
- }
- $params['in_stock'] = array(
- 'description' => __( 'Limit result set to products in stock or out of stock.', 'woocommerce' ),
- 'type' => 'boolean',
- 'sanitize_callback' => 'wc_string_to_bool',
- 'validate_callback' => 'rest_validate_request_arg',
- );
- $params['on_sale'] = array(
- 'description' => __( 'Limit result set to products on sale.', 'woocommerce' ),
- 'type' => 'boolean',
- 'sanitize_callback' => 'wc_string_to_bool',
- 'validate_callback' => 'rest_validate_request_arg',
- );
- $params['min_price'] = array(
- 'description' => __( 'Limit result set to products based on a minimum price.', 'woocommerce' ),
- 'type' => 'string',
- 'sanitize_callback' => 'sanitize_text_field',
- 'validate_callback' => 'rest_validate_request_arg',
- );
- $params['max_price'] = array(
- 'description' => __( 'Limit result set to products based on a maximum price.', 'woocommerce' ),
- 'type' => 'string',
- 'sanitize_callback' => 'sanitize_text_field',
- 'validate_callback' => 'rest_validate_request_arg',
- );
- return $params;
- }
- }
|