delete( true ); } } /** * Create simple product. * * @since 2.3 * @param bool $save Save or return object. * @param array $props Properties to be set in the new product, as an associative array. * @return WC_Product_Simple */ public static function create_simple_product( $save = true, $props = array() ) { $product = new WC_Product_Simple(); $default_props = array( 'name' => 'Dummy Product', 'regular_price' => 10, 'price' => 10, 'sku' => 'DUMMY SKU', 'manage_stock' => false, 'tax_status' => 'taxable', 'downloadable' => false, 'virtual' => false, 'stock_status' => 'instock', 'weight' => '1.1', ); $product->set_props( array_merge( $default_props, $props ) ); if ( $save ) { $product->save(); return wc_get_product( $product->get_id() ); } else { return $product; } } /** * Create external product. * * @since 3.0.0 * @return WC_Product_External */ public static function create_external_product() { $product = new WC_Product_External(); $product->set_props( array( 'name' => 'Dummy External Product', 'regular_price' => 10, 'sku' => 'DUMMY EXTERNAL SKU', 'product_url' => 'http://woocommerce.com', 'button_text' => 'Buy external product', ) ); $product->save(); return wc_get_product( $product->get_id() ); } /** * Create grouped product. * * @since 3.0.0 * @return WC_Product_Grouped */ public static function create_grouped_product() { $simple_product_1 = self::create_simple_product(); $simple_product_2 = self::create_simple_product(); $product = new WC_Product_Grouped(); $product->set_props( array( 'name' => 'Dummy Grouped Product', 'sku' => 'DUMMY GROUPED SKU', ) ); $product->set_children( array( $simple_product_1->get_id(), $simple_product_2->get_id() ) ); $product->save(); return wc_get_product( $product->get_id() ); } /** * Create a dummy variation product or configure an existing product object with dummy data. * * * @since 2.3 * @param WC_Product_Variable|null $product Product object to configure, or null to create a new one. * @return WC_Product_Variable */ public static function create_variation_product( $product = null ) { $is_new_product = is_null( $product ); if ( $is_new_product ) { $product = new WC_Product_Variable(); } $product->set_props( array( 'name' => 'Dummy Variable Product', 'sku' => 'DUMMY VARIABLE SKU', ) ); $attributes = array(); $attributes[] = self::create_product_attribute_object( 'size', array( 'small', 'large', 'huge' ) ); $attributes[] = self::create_product_attribute_object( 'colour', array( 'red', 'blue' ) ); $attributes[] = self::create_product_attribute_object( 'number', array( '0', '1', '2' ) ); $product->set_attributes( $attributes ); $product->save(); $variations = array(); $variations[] = self::create_product_variation_object( $product->get_id(), 'DUMMY SKU VARIABLE SMALL', 10, array( 'pa_size' => 'small' ) ); $variations[] = self::create_product_variation_object( $product->get_id(), 'DUMMY SKU VARIABLE LARGE', 15, array( 'pa_size' => 'large' ) ); $variations[] = self::create_product_variation_object( $product->get_id(), 'DUMMY SKU VARIABLE HUGE RED 0', 16, array( 'pa_size' => 'huge', 'pa_colour' => 'red', 'pa_number' => '0', ) ); $variations[] = self::create_product_variation_object( $product->get_id(), 'DUMMY SKU VARIABLE HUGE RED 2', 17, array( 'pa_size' => 'huge', 'pa_colour' => 'red', 'pa_number' => '2', ) ); $variations[] = self::create_product_variation_object( $product->get_id(), 'DUMMY SKU VARIABLE HUGE BLUE 2', 18, array( 'pa_size' => 'huge', 'pa_colour' => 'blue', 'pa_number' => '2', ) ); $variations[] = self::create_product_variation_object( $product->get_id(), 'DUMMY SKU VARIABLE HUGE BLUE ANY NUMBER', 19, array( 'pa_size' => 'huge', 'pa_colour' => 'blue', 'pa_number' => '', ) ); if ( $is_new_product ) { return wc_get_product( $product->get_id() ); } $variation_ids = array_map( function( $variation ) { return $variation->get_id(); }, $variations ); $product->set_children( $variation_ids ); return $product; } /** * Creates an instance of WC_Product_Variation with the supplied parameters, optionally persisting it to the database. * * @param string $parent_id Parent product id. * @param string $sku SKU for the variation. * @param int $price Price of the variation. * @param array $attributes Attributes that define the variation, e.g. ['pa_color'=>'red']. * @param bool $save If true, the object will be saved to the database after being created and configured. * * @return WC_Product_Variation The created object. */ public static function create_product_variation_object( $parent_id, $sku, $price, $attributes, $save = true ) { $variation = new WC_Product_Variation(); $variation->set_props( array( 'parent_id' => $parent_id, 'sku' => $sku, 'regular_price' => $price, ) ); $variation->set_attributes( $attributes ); if ( $save ) { $variation->save(); } return $variation; } /** * Creates an instance of WC_Product_Attribute with the supplied parameters. * * @param string $raw_name Attribute raw name (without 'pa_' prefix). * @param array $terms Possible values for the attribute. * * @return WC_Product_Attribute The created attribute object. */ public static function create_product_attribute_object( $raw_name = 'size', $terms = array( 'small' ) ) { $attribute = new WC_Product_Attribute(); $attribute_data = self::create_attribute( $raw_name, $terms ); $attribute->set_id( $attribute_data['attribute_id'] ); $attribute->set_name( $attribute_data['attribute_taxonomy'] ); $attribute->set_options( $attribute_data['term_ids'] ); $attribute->set_position( 1 ); $attribute->set_visible( true ); $attribute->set_variation( true ); return $attribute; } /** * Create a dummy attribute. * * @since 2.3 * * @param string $raw_name Name of attribute to create. * @param array(string) $terms Terms to create for the attribute. * @return array */ public static function create_attribute( $raw_name = 'size', $terms = array( 'small' ) ) { global $wpdb, $wc_product_attributes; // Make sure caches are clean. delete_transient( 'wc_attribute_taxonomies' ); WC_Cache_Helper::invalidate_cache_group( 'woocommerce-attributes' ); // These are exported as labels, so convert the label to a name if possible first. $attribute_labels = wp_list_pluck( wc_get_attribute_taxonomies(), 'attribute_label', 'attribute_name' ); $attribute_name = array_search( $raw_name, $attribute_labels, true ); if ( ! $attribute_name ) { $attribute_name = wc_sanitize_taxonomy_name( $raw_name ); } $attribute_id = wc_attribute_taxonomy_id_by_name( $attribute_name ); if ( ! $attribute_id ) { $taxonomy_name = wc_attribute_taxonomy_name( $attribute_name ); // Degister taxonomy which other tests may have created... unregister_taxonomy( $taxonomy_name ); $attribute_id = wc_create_attribute( array( 'name' => $raw_name, 'slug' => $attribute_name, 'type' => 'select', 'order_by' => 'menu_order', 'has_archives' => 0, ) ); // Register as taxonomy. register_taxonomy( $taxonomy_name, apply_filters( 'woocommerce_taxonomy_objects_' . $taxonomy_name, array( 'product' ) ), apply_filters( 'woocommerce_taxonomy_args_' . $taxonomy_name, array( 'labels' => array( 'name' => $raw_name, ), 'hierarchical' => false, 'show_ui' => false, 'query_var' => true, 'rewrite' => false, ) ) ); // Set product attributes global. $wc_product_attributes = array(); foreach ( wc_get_attribute_taxonomies() as $taxonomy ) { $wc_product_attributes[ wc_attribute_taxonomy_name( $taxonomy->attribute_name ) ] = $taxonomy; } } $attribute = wc_get_attribute( $attribute_id ); $return = array( 'attribute_name' => $attribute->name, 'attribute_taxonomy' => $attribute->slug, 'attribute_id' => $attribute_id, 'term_ids' => array(), ); foreach ( $terms as $term ) { $result = term_exists( $term, $attribute->slug ); if ( ! $result ) { $result = wp_insert_term( $term, $attribute->slug ); $return['term_ids'][] = $result['term_id']; } else { $return['term_ids'][] = $result['term_id']; } } return $return; } /** * Delete an attribute. * * @param int $attribute_id ID to delete. * * @since 2.3 */ public static function delete_attribute( $attribute_id ) { global $wpdb; $attribute_id = absint( $attribute_id ); $wpdb->query( $wpdb->prepare( "DELETE FROM {$wpdb->prefix}woocommerce_attribute_taxonomies WHERE attribute_id = %d", $attribute_id ) ); } /** * Creates a new product review on a specific product. * * @since 3.0 * @param int $product_id integer Product ID that the review is for. * @param string $review_content string Content to use for the product review. * @return integer Product Review ID. */ public static function create_product_review( $product_id, $review_content = 'Review content here' ) { $data = array( 'comment_post_ID' => $product_id, 'comment_author' => 'admin', 'comment_author_email' => 'woo@woo.local', 'comment_author_url' => '', 'comment_date' => '2016-01-01T11:11:11', 'comment_content' => $review_content, 'comment_approved' => 1, 'comment_type' => 'review', ); return wp_insert_comment( $data ); } /** * A helper function for hooking into save_post during the test_product_meta_save_post test. * @since 3.0.1 * * @param int $id ID to update. */ public static function save_post_test_update_meta_data_direct( $id ) { update_post_meta( $id, '_test2', 'world' ); } }