Created abstract product class

This commit is contained in:
Claudio Sanches 2017-05-16 01:02:46 -03:00
parent c375fa03ff
commit 020e61927b
5 changed files with 675 additions and 619 deletions

View File

@ -51,10 +51,10 @@ class WC_Admin_Importers {
} }
// includes // includes
require( dirname( __FILE__ ) . '/importers/class-wc-product-importer.php' ); require( dirname( __FILE__ ) . '/importers/class-wc-product-wp-importer.php' );
// Dispatch // Dispatch
$importer = new WC_Product_Importer(); $importer = new WC_Product_WP_Importer();
$importer->dispatch(); $importer->dispatch();
} }

View File

@ -15,7 +15,7 @@ if ( ! class_exists( 'WP_Importer' ) ) {
* @package WooCommerce/Admin/Importers * @package WooCommerce/Admin/Importers
* @version 3.1.0 * @version 3.1.0
*/ */
class WC_Product_Importer extends WP_Importer { class WC_Product_WP_Importer extends WP_Importer {
/** /**
* The current file id. * The current file id.
@ -138,7 +138,6 @@ class WC_Product_Importer extends WP_Importer {
$importer = $this->get_importer( $file, $args ); $importer = $this->get_importer( $file, $args );
$data = $importer->import(); $data = $importer->import();
$imported = count( $data['imported'] ); $imported = count( $data['imported'] );
$failed = count( $data['failed'] ); $failed = count( $data['failed'] );

View File

@ -0,0 +1,663 @@
<?php
/**
* Abstract Product importer
*
* @author Automattic
* @category Admin
* @package WooCommerce/Import
* @version 3.1.0
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* Include dependencies.
*/
if ( ! class_exists( 'WC_Importer_Interface', false ) ) {
include_once( WC_ABSPATH . 'includes/interfaces/class-wc-importer-interface.php' );
}
/**
* WC_Product_Importer Class.
*/
abstract class WC_Product_Importer implements WC_Importer_Interface {
/**
* Process each item and save.
*
* @param array $data Raw CSV data.
* @return WC_Product|WC_Error
*/
protected function process_item( $data ) {
// Ignore IDs and create new products.
// @todo Mike said that we should have something to force create.
$force_create = false;
try {
$object = $this->prepare_product( $data, $force_create );
if ( is_wp_error( $object ) ) {
return $object;
}
$object->save();
return $object->get_id();
} catch ( WC_Data_Exception $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), $e->getErrorData() );
} catch ( Exception $e ) {
return new WP_Error( 'woocommerce_product_csv_importer_error', $e->getMessage(), array( 'status' => $e->getCode() ) );
}
}
/**
* Prepare a single product for create or update.
*
* @param array $data Row data.
* @param bool $creating If should force create a new product.
* @return WC_Product|WP_Error
*/
protected function prepare_product( $data, $force_create = false ) {
$id = ! $force_create && isset( $data['id'] ) ? absint( $data['id'] ) : 0;
// Type is the most important part here because we need to be using the correct class and methods.
if ( isset( $data['type'] ) ) {
if ( ! in_array( $data['type'], array_keys( wc_get_product_types() ), true ) ) {
return new WP_Error( 'woocommerce_product_csv_importer_invalid_type', __( 'Invalid product type.', 'woocommerce' ), array( 'status' => 401 ) );
}
$classname = WC_Product_Factory::get_classname_from_product_type( $data['type'] );
if ( ! class_exists( $classname ) ) {
$classname = 'WC_Product_Simple';
}
$product = new $classname( $id );
} elseif ( isset( $data['id'] ) ) {
$product = wc_get_product( $id );
} else {
$product = new WC_Product_Simple();
}
// @todo need to check first how we'll handle variations.
if ( 'variation' === $product->get_type() ) {
$product = $this->set_variation_data( $product, $data );
} else {
$product = $this->set_product_data( $product, $data );
}
return apply_filters( 'woocommerce_product_csv_import_pre_insert_product_object', $product, $data );
}
/**
* Set product data.
*
* @param WC_Product $product Product instance.
* @param array $data Row data.
*
* @return WC_Product
*/
protected function set_product_data( $product, $data ) {
// Post title.
if ( isset( $data['name'] ) ) {
$product->set_name( wp_filter_post_kses( $data['name'] ) );
}
// Post content.
if ( isset( $data['description'] ) ) {
$product->set_description( wp_filter_post_kses( $data['description'] ) );
}
// Post excerpt.
if ( isset( $data['short_description'] ) ) {
$product->set_short_description( wp_filter_post_kses( $data['short_description'] ) );
}
// Post status.
if ( isset( $data['status'] ) ) {
$product->set_status( $data['status'] ? 'publish' : 'draft' );
}
// Post slug.
if ( isset( $data['slug'] ) ) {
$product->set_slug( $data['slug'] );
}
// Menu order.
if ( isset( $data['menu_order'] ) ) {
$product->set_menu_order( $data['menu_order'] );
}
// Comment status.
if ( isset( $data['reviews_allowed'] ) ) {
$product->set_reviews_allowed( $data['reviews_allowed'] );
}
// Virtual.
if ( isset( $data['virtual'] ) ) {
$product->set_virtual( $data['virtual'] );
}
// Tax status.
if ( isset( $data['tax_status'] ) ) {
$product->set_tax_status( $data['tax_status'] );
}
// Tax Class.
if ( isset( $data['tax_class'] ) ) {
$product->set_tax_class( $data['tax_class'] );
}
// Catalog Visibility.
if ( isset( $data['catalog_visibility'] ) ) {
$product->set_catalog_visibility( $data['catalog_visibility'] );
}
// Purchase Note.
if ( isset( $data['purchase_note'] ) ) {
$product->set_purchase_note( wc_clean( $data['purchase_note'] ) );
}
// Featured Product.
if ( isset( $data['featured'] ) ) {
$product->set_featured( $data['featured'] );
}
// Shipping data.
$product = $this->save_product_shipping_data( $product, $data );
// SKU.
if ( isset( $data['sku'] ) ) {
$product->set_sku( wc_clean( $data['sku'] ) );
}
// Attributes.
if ( isset( $data['attributes'] ) ) {
$attributes = array();
foreach ( $data['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( $data['regular_price'] ) ) {
$product->set_regular_price( $data['regular_price'] );
}
// Sale Price.
if ( isset( $data['sale_price'] ) ) {
$product->set_sale_price( $data['sale_price'] );
}
if ( isset( $data['date_on_sale_from'] ) ) {
$product->set_date_on_sale_from( $data['date_on_sale_from'] );
}
if ( isset( $data['date_on_sale_from_gmt'] ) ) {
$product->set_date_on_sale_from( $data['date_on_sale_from_gmt'] ? strtotime( $data['date_on_sale_from_gmt'] ) : null );
}
if ( isset( $data['date_on_sale_to'] ) ) {
$product->set_date_on_sale_to( $data['date_on_sale_to'] );
}
if ( isset( $data['date_on_sale_to_gmt'] ) ) {
$product->set_date_on_sale_to( $data['date_on_sale_to_gmt'] ? strtotime( $data['date_on_sale_to_gmt'] ) : null );
}
}
// Product parent ID for groups.
if ( isset( $data['parent_id'] ) ) {
$product->set_parent_id( $data['parent_id'] );
}
// Sold individually.
if ( isset( $data['sold_individually'] ) ) {
$product->set_sold_individually( $data['sold_individually'] );
}
// Stock status.
if ( isset( $data['in_stock'] ) ) {
$stock_status = true === $data['in_stock'] ? 'instock' : 'outofstock';
} else {
$stock_status = $product->get_stock_status();
}
// Stock data.
if ( 'yes' === get_option( 'woocommerce_manage_stock' ) ) {
// Manage stock.
if ( isset( $data['manage_stock'] ) ) {
$product->set_manage_stock( $data['manage_stock'] );
}
// Backorders.
if ( isset( $data['backorders'] ) ) {
$product->set_backorders( $data['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( $data['stock_quantity'] ) ) {
$product->set_stock_quantity( wc_stock_amount( $data['stock_quantity'] ) );
} elseif ( isset( $data['inventory_delta'] ) ) {
$stock_quantity = wc_stock_amount( $product->get_stock_quantity() );
$stock_quantity += wc_stock_amount( $data['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( $data['upsell_ids'] ) ) {
$upsells = array();
$ids = $data['upsell_ids'];
if ( ! empty( $ids ) ) {
foreach ( $ids as $id ) {
if ( $id && $id > 0 ) {
$upsells[] = $id;
}
}
}
$product->set_upsell_ids( $upsells );
}
// Cross sells.
if ( isset( $data['cross_sell_ids'] ) ) {
$crosssells = array();
$ids = $data['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( $data['categories'] ) && is_array( $data['categories'] ) ) {
$product = $this->save_taxonomy_terms( $product, $data['categories'] );
}
// Product tags.
if ( isset( $data['tags'] ) && is_array( $data['tags'] ) ) {
$product = $this->save_taxonomy_terms( $product, $data['tags'], 'tag' );
}
// Downloadable.
if ( isset( $data['downloadable'] ) ) {
$product->set_downloadable( $data['downloadable'] );
}
// Downloadable options.
if ( $product->get_downloadable() ) {
// Downloadable files.
if ( isset( $data['downloads'] ) && is_array( $data['downloads'] ) ) {
$product = $this->save_downloadable_files( $product, $data['downloads'] );
}
// Download limit.
if ( isset( $data['download_limit'] ) ) {
$product->set_download_limit( $data['download_limit'] );
}
// Download expiry.
if ( isset( $data['download_expiry'] ) ) {
$product->set_download_expiry( $data['download_expiry'] );
}
}
// Product url and button text for external products.
if ( $product->is_type( 'external' ) ) {
if ( isset( $data['external_url'] ) ) {
$product->set_product_url( $data['external_url'] );
}
if ( isset( $data['button_text'] ) ) {
$product->set_button_text( $data['button_text'] );
}
}
// Save default attributes for variable products.
if ( $product->is_type( 'variable' ) ) {
$product = $this->save_default_attributes( $product, $data );
}
// Check for featured/gallery images, upload it and set it.
if ( isset( $data['images'] ) ) {
$product = $this->set_product_images( $product, $data['images'] );
}
// Allow set meta_data.
if ( isset( $data['meta_data'] ) && is_array( $data['meta_data'] ) ) {
foreach ( $data['meta_data'] as $meta ) {
$product->update_meta_data( $meta['key'], $meta['value'], isset( $meta['id'] ) ? $meta['id'] : '' );
}
}
return $product;
}
/**
* Set variation data.
*
* @param WC_Product $variation Product instance.
* @param array $data Row data.
*
* @return WC_Product
*/
protected function set_variation_data( $variation, $data ) {
return $variation;
}
/**
* Set product images.
*
* @param WC_Product $product Product instance.
* @param array $images Images data.
* @return WC_Product
*/
protected function set_product_images( $product, $images ) {
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 ) ) {
if ( ! apply_filters( 'woocommerce_rest_suppress_image_upload_error', false, $upload, $product->get_id(), $images ) ) {
throw new Exception( $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 ) ) {
throw new Exception( 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'] ) );
}
}
if ( ! empty( $gallery ) ) {
$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'] ) ) {
$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 );
}
}
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 ) {
$files = array();
foreach ( $downloads as $key => $file ) {
if ( empty( $file['file'] ) ) {
continue;
}
$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;
}
$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;
}
}

View File

@ -14,14 +14,14 @@ if ( ! defined( 'ABSPATH' ) ) {
/** /**
* Include dependencies. * Include dependencies.
*/ */
if ( ! class_exists( 'WC_Importer_Interface', false ) ) { if ( ! class_exists( 'WC_Product_Importer', false ) ) {
include_once( WC_ABSPATH . 'includes/interfaces/class-wc-importer-interface.php' ); include_once( dirname( __FILE__ ) . '/abstract-wc-product-importer.php' );
} }
/** /**
* WC_Product_CSV_Importer Class. * WC_Product_CSV_Importer Class.
*/ */
class WC_Product_CSV_Importer implements WC_Importer_Interface { class WC_Product_CSV_Importer extends WC_Product_Importer {
/** /**
* CSV file. * CSV file.
@ -99,7 +99,7 @@ class WC_Product_CSV_Importer implements WC_Importer_Interface {
); );
foreach ( $this->parsed_data as $parsed_data ) { foreach ( $this->parsed_data as $parsed_data ) {
$result = $this->process_item( $data ); $result = $this->process_item( $parsed_data );
if ( is_wp_error( $result ) ) { if ( is_wp_error( $result ) ) {
$data['failed'][] = $result; $data['failed'][] = $result;
@ -107,42 +107,14 @@ class WC_Product_CSV_Importer implements WC_Importer_Interface {
$data['imported'][] = $result; $data['imported'][] = $result;
// Clean cache for updated products. // Clean cache for updated products.
wc_delete_product_transients( $result->get_id() ); wc_delete_product_transients( $result );
wp_cache_delete( 'product-' . $result->get_id(), 'products' ); wp_cache_delete( 'product-' . $result, 'products' );
} }
} }
return $data; return $data;
} }
/**
* Process each item and save.
*
* @param array $data Raw CSV data.
* @return WC_Product|WC_Error
*/
protected function process_item( $data ) {
// Ignore IDs and create new products.
// @todo Mike said that we should have something to force create.
$force_create = false;
try {
$object = $this->prepare_product( $data, $force_create );
if ( is_wp_error( $object ) ) {
return $object;
}
$object->save();
return $object->get_id();
} catch ( WC_Data_Exception $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), $e->getErrorData() );
} catch ( Exception $e ) {
return new WP_Error( 'woocommerce_product_csv_importer_error', $e->getMessage(), array( 'status' => $e->getCode() ) );
}
}
/** /**
* Get file raw headers. * Get file raw headers.
* *
@ -384,582 +356,4 @@ class WC_Product_CSV_Importer implements WC_Importer_Interface {
$this->parsed_data[] = $item; $this->parsed_data[] = $item;
} }
} }
/**
* Prepare a single product for create or update.
*
* @param array $data Row data.
* @param bool $creating If should force create a new product.
* @return WC_Product|WP_Error
*/
protected function prepare_product( $data, $force_create = false ) {
$id = ! $force_create && isset( $data['id'] ) ? absint( $data['id'] ) : 0;
// Type is the most important part here because we need to be using the correct class and methods.
if ( isset( $data['type'] ) ) {
$classname = WC_Product_Factory::get_classname_from_product_type( $data['type'] );
if ( ! class_exists( $classname ) ) {
$classname = 'WC_Product_Simple';
}
$product = new $classname( $id );
} elseif ( isset( $data['id'] ) ) {
$product = wc_get_product( $id );
} else {
$product = new WC_Product_Simple();
}
// @todo need to check first how we'll handle variations.
if ( 'variation' === $product->get_type() ) {
return new WP_Error( 'variation_not_supported', __( 'Variations are not supported yet.', 'woocommerce' ), array( 'status' => 401 ) );
}
// Post title.
if ( isset( $data['name'] ) ) {
$product->set_name( wp_filter_post_kses( $data['name'] ) );
}
// Post content.
if ( isset( $data['description'] ) ) {
$product->set_description( wp_filter_post_kses( $data['description'] ) );
}
// Post excerpt.
if ( isset( $data['short_description'] ) ) {
$product->set_short_description( wp_filter_post_kses( $data['short_description'] ) );
}
// Post status.
if ( isset( $data['status'] ) ) {
$product->set_status( get_post_status_object( $data['status'] ) ? $data['status'] : 'draft' );
}
// Post slug.
if ( isset( $data['slug'] ) ) {
$product->set_slug( $data['slug'] );
}
// Menu order.
if ( isset( $data['menu_order'] ) ) {
$product->set_menu_order( $data['menu_order'] );
}
// Comment status.
if ( isset( $data['reviews_allowed'] ) ) {
$product->set_reviews_allowed( $data['reviews_allowed'] );
}
// Virtual.
if ( isset( $data['virtual'] ) ) {
$product->set_virtual( $data['virtual'] );
}
// Tax status.
if ( isset( $data['tax_status'] ) ) {
$product->set_tax_status( $data['tax_status'] );
}
// Tax Class.
if ( isset( $data['tax_class'] ) ) {
$product->set_tax_class( $data['tax_class'] );
}
// Catalog Visibility.
if ( isset( $data['catalog_visibility'] ) ) {
$product->set_catalog_visibility( $data['catalog_visibility'] );
}
// Purchase Note.
if ( isset( $data['purchase_note'] ) ) {
$product->set_purchase_note( wc_clean( $data['purchase_note'] ) );
}
// Featured Product.
if ( isset( $data['featured'] ) ) {
$product->set_featured( $data['featured'] );
}
// Shipping data.
$product = $this->save_product_shipping_data( $product, $data );
// SKU.
if ( isset( $data['sku'] ) ) {
$product->set_sku( wc_clean( $data['sku'] ) );
}
// Attributes.
if ( isset( $data['attributes'] ) ) {
$attributes = array();
foreach ( $data['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( $data['regular_price'] ) ) {
$product->set_regular_price( $data['regular_price'] );
}
// Sale Price.
if ( isset( $data['sale_price'] ) ) {
$product->set_sale_price( $data['sale_price'] );
}
if ( isset( $data['date_on_sale_from'] ) ) {
$product->set_date_on_sale_from( $data['date_on_sale_from'] );
}
if ( isset( $data['date_on_sale_from_gmt'] ) ) {
$product->set_date_on_sale_from( $data['date_on_sale_from_gmt'] ? strtotime( $data['date_on_sale_from_gmt'] ) : null );
}
if ( isset( $data['date_on_sale_to'] ) ) {
$product->set_date_on_sale_to( $data['date_on_sale_to'] );
}
if ( isset( $data['date_on_sale_to_gmt'] ) ) {
$product->set_date_on_sale_to( $data['date_on_sale_to_gmt'] ? strtotime( $data['date_on_sale_to_gmt'] ) : null );
}
}
// Product parent ID for groups.
if ( isset( $data['parent_id'] ) ) {
$product->set_parent_id( $data['parent_id'] );
}
// Sold individually.
if ( isset( $data['sold_individually'] ) ) {
$product->set_sold_individually( $data['sold_individually'] );
}
// Stock status.
if ( isset( $data['in_stock'] ) ) {
$stock_status = true === $data['in_stock'] ? 'instock' : 'outofstock';
} else {
$stock_status = $product->get_stock_status();
}
// Stock data.
if ( 'yes' === get_option( 'woocommerce_manage_stock' ) ) {
// Manage stock.
if ( isset( $data['manage_stock'] ) ) {
$product->set_manage_stock( $data['manage_stock'] );
}
// Backorders.
if ( isset( $data['backorders'] ) ) {
$product->set_backorders( $data['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( $data['stock_quantity'] ) ) {
$product->set_stock_quantity( wc_stock_amount( $data['stock_quantity'] ) );
} elseif ( isset( $data['inventory_delta'] ) ) {
$stock_quantity = wc_stock_amount( $product->get_stock_quantity() );
$stock_quantity += wc_stock_amount( $data['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( $data['upsell_ids'] ) ) {
$upsells = array();
$ids = $data['upsell_ids'];
if ( ! empty( $ids ) ) {
foreach ( $ids as $id ) {
if ( $id && $id > 0 ) {
$upsells[] = $id;
}
}
}
$product->set_upsell_ids( $upsells );
}
// Cross sells.
if ( isset( $data['cross_sell_ids'] ) ) {
$crosssells = array();
$ids = $data['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( $data['categories'] ) && is_array( $data['categories'] ) ) {
$product = $this->save_taxonomy_terms( $product, $data['categories'] );
}
// Product tags.
if ( isset( $data['tags'] ) && is_array( $data['tags'] ) ) {
$product = $this->save_taxonomy_terms( $product, $data['tags'], 'tag' );
}
// Downloadable.
if ( isset( $data['downloadable'] ) ) {
$product->set_downloadable( $data['downloadable'] );
}
// Downloadable options.
if ( $product->get_downloadable() ) {
// Downloadable files.
if ( isset( $data['downloads'] ) && is_array( $data['downloads'] ) ) {
$product = $this->save_downloadable_files( $product, $data['downloads'] );
}
// Download limit.
if ( isset( $data['download_limit'] ) ) {
$product->set_download_limit( $data['download_limit'] );
}
// Download expiry.
if ( isset( $data['download_expiry'] ) ) {
$product->set_download_expiry( $data['download_expiry'] );
}
}
// Product url and button text for external products.
if ( $product->is_type( 'external' ) ) {
if ( isset( $data['external_url'] ) ) {
$product->set_product_url( $data['external_url'] );
}
if ( isset( $data['button_text'] ) ) {
$product->set_button_text( $data['button_text'] );
}
}
// Save default attributes for variable products.
if ( $product->is_type( 'variable' ) ) {
$product = $this->save_default_attributes( $product, $data );
}
// Check for featured/gallery images, upload it and set it.
if ( isset( $data['images'] ) ) {
$product = $this->set_product_images( $product, $data['images'] );
}
// Allow set meta_data.
if ( isset( $data['meta_data'] ) && is_array( $data['meta_data'] ) ) {
foreach ( $data['meta_data'] as $meta ) {
$product->update_meta_data( $meta['key'], $meta['value'], isset( $meta['id'] ) ? $meta['id'] : '' );
}
}
return apply_filters( 'woocommerce_product_csv_import_pre_insert_product_object', $product, $data );
}
/**
* Set product images.
*
* @param WC_Product $product Product instance.
* @param array $images Images data.
* @return WC_Product
*/
protected function set_product_images( $product, $images ) {
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 ) ) {
if ( ! apply_filters( 'woocommerce_rest_suppress_image_upload_error', false, $upload, $product->get_id(), $images ) ) {
throw new Exception( $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 ) ) {
throw new Exception( 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'] ) );
}
}
if ( ! empty( $gallery ) ) {
$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'] ) ) {
$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 );
}
}
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 ) {
$files = array();
foreach ( $downloads as $key => $file ) {
if ( empty( $file['file'] ) ) {
continue;
}
$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;
}
$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;
}
} }

View File

@ -1,4 +1,4 @@
Type,SKU,Name,Status,Regular price Type,SKU,Name,Status,Regular price
regular,PRODUCT-01,Imported Product 1,1,40 simple,PRODUCT-01,Imported Product 1,1,40
regular,PRODUCT-02,Imported Product 2,1,41 simple,PRODUCT-02,Imported Product 2,1,41
regular,PRODUCT-03,Imported Product 3,1,42 simple,PRODUCT-03,Imported Product 3,1,42

1 Type SKU Name Status Regular price
2 regular simple PRODUCT-01 Imported Product 1 1 40
3 regular simple PRODUCT-02 Imported Product 2 1 41
4 regular simple PRODUCT-03 Imported Product 3 1 42