-
Notifications
You must be signed in to change notification settings - Fork 10.8k
/
class-wc-product-variation.php
650 lines (570 loc) · 19.7 KB
/
class-wc-product-variation.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
<?php
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* Product Variation Class
*
* The WooCommerce product variation class handles product variation data.
*
* @class WC_Product_Variation
* @version 2.2.0
* @package WooCommerce/Classes
* @category Class
* @author WooThemes
*/
class WC_Product_Variation extends WC_Product {
/** @public int ID of the variable product. */
public $variation_id;
/** @public object Parent Variable product object. */
public $parent;
/** @public string Stores the shipping class of the variation. */
public $variation_shipping_class = false;
/** @public int Stores the shipping class ID of the variation. */
public $variation_shipping_class_id = false;
/** @public unused vars @deprecated in 2.2 */
public $variation_has_sku = true;
public $variation_has_length = true;
public $variation_has_width = true;
public $variation_has_height = true;
public $variation_has_weight = true;
public $variation_has_tax_class = true;
public $variation_has_downloadable_files = true;
/** @private array Data which is only at variation level - no inheritance plus their default values if left blank. */
protected $variation_level_meta_data = array(
'downloadable' => 'no',
'virtual' => 'no',
'manage_stock' => 'no',
'sale_price_dates_from' => '',
'sale_price_dates_to' => '',
'price' => '',
'regular_price' => '',
'sale_price' => '',
'stock' => 0,
'stock_status' => 'instock',
'downloadable_files' => array()
);
/** @private array Data which can be at variation level, otherwise fallback to parent if not set. */
protected $variation_inherited_meta_data = array(
'tax_class' => '',
'backorders' => 'no',
'sku' => '',
'weight' => '',
'length' => '',
'width' => '',
'height' => ''
);
/**
* Loads required variation data.
*
* @access public
* @param int $variation ID of the variation to load
* @param array $args Array of the arguments containing parent product data
*/
public function __construct( $variation, $args = array() ) {
if ( is_object( $variation ) ) {
$this->variation_id = absint( $variation->ID );
} else {
$this->variation_id = absint( $variation );
}
/* Get main product data from parent (args) */
$this->id = ! empty( $args['parent_id'] ) ? intval( $args['parent_id'] ) : wp_get_post_parent_id( $this->variation_id );
// The post doesn't have a parent id, therefore its invalid.
if ( empty( $this->id ) ) {
return;
}
$this->product_type = 'variation';
$this->parent = ! empty( $args['parent'] ) ? $args['parent'] : get_product( $this->id );
$this->post = ! empty( $this->parent->post ) ? $this->parent->post : array();
}
/**
* __isset function.
*
* @access public
* @param mixed $key
* @return bool
*/
public function __isset( $key ) {
if ( in_array( $key, array_keys( $this->variation_level_meta_data ) ) ) {
return metadata_exists( 'post', $this->variation_id, '_' . $key );
} elseif ( in_array( $key, array_keys( $this->variation_inherited_meta_data ) ) ) {
return metadata_exists( 'post', $this->variation_id, '_' . $key ) || metadata_exists( 'post', $this->id, '_' . $key );
} else {
return metadata_exists( 'post', $this->id, '_' . $key );
}
}
/**
* Get method returns variation meta data if set, otherwise in most cases the data from the parent.
*
* @access public
* @param string $key
* @return mixed
*/
public function __get( $key ) {
if ( in_array( $key, array_keys( $this->variation_level_meta_data ) ) ) {
$value = get_post_meta( $this->variation_id, '_' . $key, true );
if ( '' === $value ) {
$value = $this->variation_level_meta_data[ $key ];
}
} elseif ( in_array( $key, array_keys( $this->variation_inherited_meta_data ) ) ) {
$value = metadata_exists( 'post', $this->variation_id, '_' . $key ) ? get_post_meta( $this->variation_id, '_' . $key, true ) : get_post_meta( $this->id, '_' . $key, true );
// Handle meta data keys which can be empty at variation level to cause inheritance
if ( '' === $value && in_array( $key, array( 'sku', 'weight', 'length', 'height' ) ) ) {
$value = get_post_meta( $this->id, '_' . $key, true );
}
if ( '' === $value ) {
$value = $this->variation_inherited_meta_data[ $key ];
}
} elseif ( 'variation_data' === $key ) {
$all_meta = get_post_meta( $this->variation_id );
// The variation data array
$this->variation_data = array();
// Get the variation attributes from meta
foreach ( $all_meta as $name => $value ) {
if ( ! strstr( $name, 'attribute_' ) ) {
continue;
}
$this->variation_data[ $name ] = sanitize_title( $value[0] );
}
return $this->variation_data;
} elseif ( 'variation_has_stock' === $key ) {
return $this->managing_stock();
} else {
$value = parent::__get( $key );
}
return $value;
}
/**
* Returns whether or not the product post exists.
*
* @access public
* @return bool
*/
public function exists() {
return ! empty( $this->id );
}
/**
* Wrapper for get_permalink. Adds this variations attributes to the URL.
* @return string
*/
public function get_permalink() {
return add_query_arg( array_filter( $this->variation_data ), get_permalink( $this->id ) );
}
/**
* Get the add to url used mainly in loops.
*
* @access public
* @return string
*/
public function add_to_cart_url() {
$url = $this->is_purchasable() && $this->is_in_stock() ? remove_query_arg( 'added-to-cart', add_query_arg( array_merge( array( 'variation_id' => $this->variation_id, 'add-to-cart' => $this->id ), $this->variation_data ) ) ) : get_permalink( $this->id );
return apply_filters( 'woocommerce_product_add_to_cart_url', $url, $this );
}
/**
* Get the add to cart button text
*
* @access public
* @return string
*/
public function add_to_cart_text() {
$text = $this->is_purchasable() && $this->is_in_stock() ? __( 'Add to cart', 'woocommerce' ) : __( 'Read More', 'woocommerce' );
return apply_filters( 'woocommerce_product_add_to_cart_text', $text, $this );
}
/**
* Checks if this particular variation is visible (variations with no price, or out of stock, can be hidden)
*
* @return bool
*/
public function variation_is_visible() {
$visible = true;
// Published == enabled checkbox
if ( get_post_status( $this->variation_id ) != 'publish' ) {
$visible = false;
}
// Out of stock visibility
elseif ( get_option('woocommerce_hide_out_of_stock_items') == 'yes' && ! $this->is_in_stock() ) {
$visible = false;
}
// Price not set
elseif ( $this->get_price() === "" ) {
$visible = false;
}
return apply_filters( 'woocommerce_variation_is_visible', $visible, $this->variation_id, $this->id );
}
/**
* Returns false if the product cannot be bought.
*
* @access public
* @return bool
*/
public function is_purchasable() {
// Published == enabled checkbox
if ( get_post_status( $this->variation_id ) != 'publish' ) {
$purchasable = false;
} else {
$purchasable = parent::is_purchasable();
}
return apply_filters( 'woocommerce_variation_is_purchasable', $purchasable, $this );
}
/**
* Returns whether or not the variations parent is visible.
*
* @access public
* @return bool
*/
public function parent_is_visible() {
return $this->is_visible();
}
/**
* Get variation ID
*
* @return int
*/
public function get_variation_id() {
return absint( $this->variation_id );
}
/**
* Get variation attribute values
*
* @return array of attributes and their values for this variation
*/
public function get_variation_attributes() {
return $this->variation_data;
}
/**
* Get variation price HTML. Prices are not inherited from parents.
*
* @return string containing the formatted price
*/
public function get_price_html( $price = '' ) {
$tax_display_mode = get_option( 'woocommerce_tax_display_shop' );
$display_price = $tax_display_mode == 'incl' ? $this->get_price_including_tax() : $this->get_price_excluding_tax();
$display_regular_price = $tax_display_mode == 'incl' ? $this->get_price_including_tax( 1, $this->get_regular_price() ) : $this->get_price_excluding_tax( 1, $this->get_regular_price() );
$display_sale_price = $tax_display_mode == 'incl' ? $this->get_price_including_tax( 1, $this->get_sale_price() ) : $this->get_price_excluding_tax( 1, $this->get_sale_price() );
if ( $this->get_price() !== '' ) {
if ( $this->is_on_sale() ) {
$price = apply_filters( 'woocommerce_variation_sale_price_html', '<del>' . wc_price( $display_regular_price ) . '</del> <ins>' . wc_price( $display_sale_price ) . '</ins>' . $this->get_price_suffix(), $this );
} elseif ( $this->get_price() > 0 ) {
$price = apply_filters( 'woocommerce_variation_price_html', wc_price( $display_price ) . $this->get_price_suffix(), $this );
} else {
$price = apply_filters( 'woocommerce_variation_free_price_html', __( 'Free!', 'woocommerce' ), $this );
}
} else {
$price = apply_filters( 'woocommerce_variation_empty_price_html', '', $this );
}
return apply_filters( 'woocommerce_get_variation_price_html', $price, $this );
}
/**
* Gets the main product image ID.
* @return int
*/
public function get_image_id() {
if ( $this->variation_id && has_post_thumbnail( $this->variation_id ) ) {
$image_id = get_post_thumbnail_id( $this->variation_id );
} elseif ( has_post_thumbnail( $this->id ) ) {
$image_id = get_post_thumbnail_id( $this->id );
} elseif ( ( $parent_id = wp_get_post_parent_id( $this->id ) ) && has_post_thumbnail( $parent_id ) ) {
$image_id = get_post_thumbnail_id( $parent_id );
} else {
$image_id = 0;
}
return $image_id;
}
/**
* Gets the main product image.
*
* @access public
* @param string $size (default: 'shop_thumbnail')
* @return string
*/
public function get_image( $size = 'shop_thumbnail', $attr = array() ) {
if ( $this->variation_id && has_post_thumbnail( $this->variation_id ) ) {
$image = get_the_post_thumbnail( $this->variation_id, $size, $attr );
} elseif ( has_post_thumbnail( $this->id ) ) {
$image = get_the_post_thumbnail( $this->id, $size, $attr );
} elseif ( ( $parent_id = wp_get_post_parent_id( $this->id ) ) && has_post_thumbnail( $parent_id ) ) {
$image = get_the_post_thumbnail( $parent_id, $size , $attr);
} else {
$image = wc_placeholder_img( $size );
}
return $image;
}
/**
* Returns whether or not the product (or variation) is stock managed.
*
* @access public
* @return bool|string Bool if managed at variation level, 'parent' if managed by the parent.
*/
public function managing_stock() {
if ( 'yes' === get_option( 'woocommerce_manage_stock', 'yes' ) ) {
if ( 'no' === $this->manage_stock ) {
if ( $this->parent->managing_stock() ) {
return 'parent';
}
} else {
return true;
}
}
return false;
}
/**
* Returns number of items available for sale from the variation, or parent.
*
* @access public
* @return int
*/
public function get_stock_quantity() {
return true === $this->managing_stock() ? wc_stock_amount( $this->stock ) : $this->parent->get_stock_quantity();
}
/**
* Returns whether or not the product is in stock.
*
* @access public
* @return bool
*/
public function is_in_stock() {
// If we're managing stock at variation level, check stock levels
if ( true === $this->managing_stock() ) {
if ( $this->backorders_allowed() ) {
return true;
} elseif ( $this->get_stock_quantity() <= get_option( 'woocommerce_notify_no_stock_amount' ) ) {
return false;
} else {
return $this->stock_status === 'instock';
}
} else {
return $this->stock_status === 'instock';
}
}
/**
* Set stock level of the product variation.
*
* Uses queries rather than update_post_meta so we can do this in one query (to avoid stock issues).
* We cannot rely on the original loaded value in case another order was made since then.
*
* @param int $amount
* @param string $mode can be set, add, or subtract
* @return int new stock level
*/
public function set_stock( $amount = null, $mode = 'set' ) {
global $wpdb;
if ( ! is_null( $amount ) && true === $this->managing_stock() ) {
// Ensure key exists
add_post_meta( $this->variation_id, '_stock', 0, true );
// Update stock in DB directly
switch ( $mode ) {
case 'add' :
$wpdb->query( "UPDATE {$wpdb->postmeta} SET meta_value = meta_value + {$amount} WHERE post_id = {$this->variation_id} AND meta_key='_stock'" );
break;
case 'subtract' :
$wpdb->query( "UPDATE {$wpdb->postmeta} SET meta_value = meta_value - {$amount} WHERE post_id = {$this->variation_id} AND meta_key='_stock'" );
break;
default :
$wpdb->query( "UPDATE {$wpdb->postmeta} SET meta_value = {$amount} WHERE post_id = {$this->variation_id} AND meta_key='_stock'" );
break;
}
// Clear caches
wp_cache_delete( $this->variation_id, 'post_meta' );
// Clear total stock transient
delete_transient( 'wc_product_total_stock_' . $this->id );
// Stock status
$this->check_stock_status();
// Sync the parent
WC_Product_Variable::sync( $this->id );
// Trigger action
do_action( 'woocommerce_variation_set_stock', $this );
} elseif ( ! is_null( $amount ) ) {
return $this->parent->set_stock( $amount, $mode );
}
return $this->get_stock_quantity();
}
/**
* set_stock_status function.
*
* @access public
*/
public function set_stock_status( $status ) {
$status = 'outofstock' === $status ? 'outofstock' : 'instock';
// Sanity check
if ( true === $this->managing_stock() ) {
if ( ! $this->backorders_allowed() && $this->get_stock_quantity() <= get_option( 'woocommerce_notify_no_stock_amount' ) ) {
$status = 'outofstock';
}
} elseif ( 'parent' === $this->managing_stock() ) {
if ( ! $this->parent->backorders_allowed() && $this->parent->get_stock_quantity() <= get_option( 'woocommerce_notify_no_stock_amount' ) ) {
$status = 'outofstock';
}
}
if ( update_post_meta( $this->variation_id, '_stock_status', $status ) ) {
do_action( 'woocommerce_variation_set_stock_status', $this->variation_id, $status );
if ( true === $this->managing_stock() ) {
WC_Product_Variable::sync_stock_status( $this->id );
}
}
}
/**
* Reduce stock level of the product.
*
* @param int $amount (default: 1) Amount to reduce by
* @return int stock level
*/
public function reduce_stock( $amount = 1 ) {
if ( true === $this->managing_stock() ) {
return $this->set_stock( $amount, 'subtract' );
} else {
return $this->parent->reduce_stock( $amount );
}
}
/**
* Increase stock level of the product.
*
* @param int $amount (default: 1) Amount to increase by
* @return int stock level
*/
public function increase_stock( $amount = 1 ) {
if ( true === $this->managing_stock() ) {
return $this->set_stock( $amount, 'add' );
} else {
return $this->parent->increase_stock( $amount );
}
}
/**
* Returns the availability of the product.
*
* @access public
* @return string
*/
public function get_availability() {
$availability = $class = '';
if ( $this->managing_stock() ) {
if ( $this->is_in_stock() && $this->get_stock_quantity() > get_option( 'woocommerce_notify_no_stock_amount' ) ) {
switch ( get_option( 'woocommerce_stock_format' ) ) {
case 'no_amount' :
$availability = __( 'In stock', 'woocommerce' );
break;
case 'low_amount' :
if ( $this->get_stock_quantity() <= get_option( 'woocommerce_notify_low_stock_amount' ) ) {
$availability = sprintf( __( 'Only %s left in stock', 'woocommerce' ), $this->get_stock_quantity() );
if ( $this->backorders_allowed() && $this->backorders_require_notification() ) {
$availability .= ' ' . __( '(can be backordered)', 'woocommerce' );
}
} else {
$availability = __( 'In stock', 'woocommerce' );
}
break;
default :
$availability = sprintf( __( '%s in stock', 'woocommerce' ), $this->get_stock_quantity() );
if ( $this->backorders_allowed() && $this->backorders_require_notification() ) {
$availability .= ' ' . __( '(can be backordered)', 'woocommerce' );
}
break;
}
$class = 'in-stock';
} elseif ( $this->backorders_allowed() && $this->backorders_require_notification() ) {
$availability = __( 'Available on backorder', 'woocommerce' );
$class = 'available-on-backorder';
} elseif ( $this->backorders_allowed() ) {
$availability = __( 'In stock', 'woocommerce' );
$class = 'in-stock';
} else {
$availability = __( 'Out of stock', 'woocommerce' );
$class = 'out-of-stock';
}
} elseif ( ! $this->is_in_stock() ) {
$availability = __( 'Out of stock', 'woocommerce' );
$class = 'out-of-stock';
}
return apply_filters( 'woocommerce_get_availability', array( 'availability' => $availability, 'class' => $class ), $this );
}
/**
* Returns whether or not the product needs to notify the customer on backorder.
*
* @access public
* @return bool
*/
public function backorders_require_notification() {
if ( true === $this->managing_stock() ) {
return parent::backorders_require_notification();
} else {
return $this->parent->backorders_require_notification();
}
}
/**
* is_on_backorder function.
*
* @access public
* @param int $qty_in_cart (default: 0)
* @return bool
*/
public function is_on_backorder( $qty_in_cart = 0 ) {
if ( true === $this->managing_stock() ) {
return parent::is_on_backorder( $qty_in_cart );
} else {
return $this->parent->is_on_backorder( $qty_in_cart );
}
}
/**
* Returns whether or not the product has enough stock for the order.
*
* @access public
* @param mixed $quantity
* @return bool
*/
public function has_enough_stock( $quantity ) {
if ( true === $this->managing_stock() ) {
return parent::has_enough_stock( $quantity );
} else {
return $this->parent->has_enough_stock( $quantity );
}
}
/**
* Get the shipping class, and if not set, get the shipping class of the parent.
*
* @access public
* @return string
*/
public function get_shipping_class() {
if ( ! $this->variation_shipping_class ) {
$classes = get_the_terms( $this->variation_id, 'product_shipping_class' );
if ( $classes && ! is_wp_error( $classes ) ) {
$this->variation_shipping_class = current( $classes )->slug;
} else {
$this->variation_shipping_class = parent::get_shipping_class();
}
}
return $this->variation_shipping_class;
}
/**
* Returns the product shipping class ID.
*
* @access public
* @return int
*/
public function get_shipping_class_id() {
if ( ! $this->variation_shipping_class_id ) {
$classes = get_the_terms( $this->variation_id, 'product_shipping_class' );
if ( $classes && ! is_wp_error( $classes ) ) {
$this->variation_shipping_class_id = current( $classes )->term_id;
} else {
$this->variation_shipping_class_id = parent::get_shipping_class_id();
}
}
return absint( $this->variation_shipping_class_id );
}
/**
* Get product name with extra details such as SKU, price and attributes. Used within admin.
*
* @access public
* @return string Formatted product name, including attributes and price
*/
public function get_formatted_name() {
if ( $this->get_sku() ) {
$identifier = $this->get_sku();
} else {
$identifier = '#' . $this->variation_id;
}
$attributes = $this->get_variation_attributes();
$extra_data = ' – ' . implode( ', ', $attributes ) . ' – ' . wc_price( $this->get_price() );
return sprintf( __( '%s – %s%s', 'woocommerce' ), $identifier, $this->get_title(), $extra_data );
}
}