class-wc-subscriptions-switcher.php
79.7 KB
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
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
<?php
/**
* A class to make it possible to switch between different subscriptions (i.e. upgrade/downgrade a subscription)
*
* @package WooCommerce Subscriptions
* @subpackage WC_Subscriptions_Switcher
* @category Class
* @author Brent Shepherd
* @since 1.4
*/
class WC_Subscriptions_Switcher {
/* cache whether a given product is purchasable or not to save running lots of queries for the same product in the same request */
protected static $is_purchasable_cache = array();
/**
* Bootstraps the class and hooks required actions & filters.
*
* @since 1.4
*/
public static function init() {
// Check if the current request is for switching a subscription and if so, start he switching process
add_filter( 'template_redirect', __CLASS__ . '::subscription_switch_handler', 100 );
// Pass in the filter switch to the group items
add_filter( 'woocommerce_grouped_product_list_link', __CLASS__ . '::add_switch_query_arg_grouped', 12 );
add_filter( 'post_type_link', __CLASS__ . '::add_switch_query_arg_post_link', 12, 2 );
// Add the settings to control whether Switching is enabled and how it will behave
add_filter( 'woocommerce_subscription_settings', __CLASS__ . '::add_settings' );
// Add the "Switch" button to the View Subscription table
add_filter( 'woocommerce_order_item_meta_end', __CLASS__ . '::print_switch_link', 10, 3 );
// We need to create subscriptions on checkout and want to do it after almost all other extensions have added their products/items/fees
add_action( 'woocommerce_checkout_order_processed', __CLASS__ . '::process_checkout', 50, 2 );
// When creating an order, add meta if it's for switching a subscription
add_action( 'woocommerce_checkout_update_order_meta', __CLASS__ . '::add_order_meta', 10, 2 );
// For order items created as part of a switch, keep a record of the prorated amounts
add_action( 'woocommerce_add_order_item_meta', __CLASS__ . '::add_order_item_meta', 10, 3 );
// For subscription items created as part of a switch, keep a record of the relationship between the items
add_action( 'woocommerce_add_subscription_item_meta', __CLASS__ . '::set_subscription_item_meta', 50, 3 );
// Add a renewal orders section to the Related Orders meta box
add_action( 'woocommerce_subscriptions_related_orders_meta_box_rows', __CLASS__ . '::switch_order_meta_box_rows', 10 );
// Don't allow switching to the same product
add_filter( 'woocommerce_add_to_cart_validation', __CLASS__ . '::validate_switch_request', 10, 4 );
// Record subscription switching in the cart
add_action( 'woocommerce_add_cart_item_data', __CLASS__ . '::set_switch_details_in_cart', 10, 3 );
// Make sure the 'switch_subscription' cart item data persists
add_action( 'woocommerce_get_cart_item_from_session', __CLASS__ . '::get_cart_from_session', 10, 3 );
// Set totals for subscription switch orders (needs to be hooked just before WC_Subscriptions_Cart::calculate_subscription_totals())
add_filter( 'woocommerce_before_calculate_totals', __CLASS__ . '::calculate_prorated_totals', 99, 1 );
// Don't display free trials when switching a subscription, because no free trials are provided
add_filter( 'woocommerce_subscriptions_product_price_string_inclusions', __CLASS__ . '::customise_product_string_inclusions', 12, 2 );
// Allow switching between variations on a limited subscription
add_filter( 'woocommerce_subscription_is_purchasable', __CLASS__ . '::is_purchasable', 12, 2 );
add_filter( 'woocommerce_subscription_variation_is_purchasable', __CLASS__ . '::is_purchasable', 12, 2 );
// Autocomplete subscription switch orders
add_action( 'woocommerce_payment_complete_order_status', __CLASS__ . '::subscription_switch_autocomplete', 10, 2 );
// Don't carry switch meta data to renewal orders
add_filter( 'wcs_renewal_order_meta_query', __CLASS__ . '::remove_renewal_order_meta_query', 10 );
// Don't carry switch meta data to renewal orders
add_filter( 'woocommerce_subscriptions_recurring_cart_key', __CLASS__ . '::get_recurring_cart_key', 10, 2 );
// Make sure the first renewal date takes into account any prorated length of time for upgrades/downgrades
add_filter( 'wcs_recurring_cart_next_payment_date', __CLASS__ . '::recurring_cart_next_payment_date', 100, 2 );
// Make sure the new end date starts from the end of the time that has already paid for
add_filter( 'wcs_recurring_cart_end_date', __CLASS__ . '::recurring_cart_end_date', 100, 3 );
// Make sure the switch process persists when having to choose product addons
add_action( 'addons_add_to_cart_url', __CLASS__ . '::addons_add_to_cart_url', 10 );
// Make sure the switch process persists when having to choose product addons
add_action( 'woocommerce_hidden_order_itemmeta', __CLASS__ . '::hidden_order_itemmeta', 10 );
// Add/remove the print switch link filters when printing HTML/plain subscription emails
add_action( 'woocommerce_email_before_subscription_table', __CLASS__ . '::remove_print_switch_link' );
add_filter( 'woocommerce_email_order_items_table', __CLASS__ . '::add_print_switch_link' );
// Make sure sign-up fees paid on switch orders are accounted for in an items sign-up fee
add_filter( 'woocommerce_subscription_items_sign_up_fee', __CLASS__ . '::subscription_items_sign_up_fee', 10, 3 );
// Make sure switch orders are included in related orders returned for a subscription
add_filter( 'woocommerce_subscription_related_orders', __CLASS__ . '::add_related_orders', 10, 4 );
// Display/indicate whether a cart switch item is a upgrade/downgrade/crossgrade
add_filter( 'woocommerce_cart_item_subtotal', __CLASS__ . '::add_cart_item_switch_direction', 10, 3 );
// Check if the new order was to record a switch request and maybe call a "switch completed" action.
add_action( 'subscriptions_created_for_order', __CLASS__ . '::maybe_add_switched_callback', 10, 1 );
// Revoke download permissions from old switch item
add_action( 'woocommerce_subscriptions_switched_item', __CLASS__ . '::remove_download_permissions_after_switch', 10, 3 );
}
/**
* Handles the subscription upgrade/downgrade process.
*
* @since 1.4
*/
public static function subscription_switch_handler() {
global $post;
// If the current user doesn't own the subscription, remove the query arg from the URL
if ( isset( $_GET['switch-subscription'] ) ) {
$subscription = wcs_get_subscription( $_GET['switch-subscription'] );
// Visiting a switch link for someone elses subscription or if the switch link doesn't contain a valid nonce
if ( ! is_object( $subscription ) || ! current_user_can( 'switch_shop_subscription', $subscription->id ) || empty( $_GET['_wcsnonce'] ) || ! wp_verify_nonce( $_GET['_wcsnonce'], 'wcs_switch_request' ) || 'no' === get_option( WC_Subscriptions_Admin::$option_prefix . '_allow_switching', 'no' ) ) {
wp_redirect( remove_query_arg( array( 'switch-subscription', 'auto-switch', 'item', '_wcsnonce' ) ) );
exit();
} else {
if ( isset( $_GET['auto-switch'] ) ) {
$switch_message = __( 'You have a subscription to this product. Choosing a new subscription will replace your existing subscription.', 'woocommerce-subscriptions' );
} else {
$switch_message = __( 'Choose a new subscription.', 'woocommerce-subscriptions' );
}
WC_Subscriptions::add_notice( $switch_message, 'notice' );
}
} elseif ( ( is_cart() || is_checkout() ) && ! is_order_received_page() && false !== ( $switch_items = self::cart_contains_switches() ) ) {
$removed_item_count = 0;
foreach ( $switch_items as $cart_item_key => $switch_item ) {
$subscription = wcs_get_subscription( $switch_item['subscription_id'] );
if ( ! is_object( $subscription ) || ! current_user_can( 'switch_shop_subscription', $subscription->id ) || ! wcs_is_product_switchable_type( WC()->cart->cart_contents[ $cart_item_key ]['data'] ) ) {
WC()->cart->remove_cart_item( $cart_item_key );
$removed_item_count++;
}
}
if ( $removed_item_count > 0 ) {
WC_Subscriptions::add_notice( _n( 'Your cart contained an invalid subscription switch request. It has been removed.', 'Your cart contained invalid subscription switch requests. They have been removed.', $removed_item_count, 'woocommerce-subscriptions' ), 'error' );
wp_redirect( WC()->cart->get_cart_url() );
exit();
}
} elseif ( is_product() && $product = wc_get_product( $post ) ) { // Automatically initiate the switch process for limited variable subscriptions
if ( wcs_is_product_switchable_type( $product ) && 'no' != $product->limit_subscriptions ) {
// Check if the user has an active subscription for this product, and if so, initiate the switch process
$subscriptions = wcs_get_users_subscriptions();
$child_ids = $product->get_children();
foreach ( $subscriptions as $subscription ) {
// If we're on a grouped product's page, we need to check if the subscription has a child of this grouped product that needs to be switched
$subscription_product_id = false;
if ( $product->is_type( 'grouped' ) ) {
foreach ( $child_ids as $child_id ) {
if ( $subscription->has_product( $child_id ) ) {
$subscription_product_id = $child_id;
break;
}
}
}
if ( $subscription->has_product( $product->id ) || $subscription_product_id ) {
// For grouped products, we need to check the child products limitations, not the grouped product's (which will have no limitation)
if ( $subscription_product_id ) {
$child_product = wc_get_product( $subscription_product_id );
$limitation = $child_product->limit_subscriptions;
} else {
$limitation = $product->limit_subscriptions;
}
// If the product is limited
if ( 'any' == $limitation || $subscription->has_status( $limitation ) || ( 'active' == $limitation && $subscription->has_status( 'on-hold' ) ) ) {
$subscribed_notice = __( 'You have already subscribed to this product and it is limited to one per customer. You can not purchase the product again.', 'woocommerce-subscriptions' );
// If switching is enabled for this product type, initiate the auto-switch process
if ( wcs_is_product_switchable_type( $product ) ) {
// Don't initiate auto-switching when the subscription requires payment
if ( $subscription->needs_payment() ) {
$last_order = $subscription->get_last_order( 'all' );
if ( $last_order->needs_payment() ) {
// translators: 1$: is the "You have already subscribed to this product" notice, 2$-4$: opening/closing link tags, 3$: an order number
$subscribed_notice = sprintf( __( '%1$s Complete payment on %2$sOrder %3$s%4$s to be able to change your subscription.', 'woocommerce-subscriptions' ), $subscribed_notice, sprintf( '<a href="%s">', $last_order->get_checkout_payment_url() ), $last_order->get_order_number(), '</a>' );
}
WC_Subscriptions::add_notice( $subscribed_notice, 'notice' );
break;
} else {
$product_id = ( $subscription_product_id ) ? $subscription_product_id : $product->id;
// Get the matching item
foreach ( $subscription->get_items() as $line_item_id => $line_item ) {
if ( $line_item['product_id'] == $product_id || $line_item['variation_id'] == $product_id ) {
$item_id = $line_item_id;
$item = $line_item;
break;
}
}
wp_redirect( add_query_arg( 'auto-switch', 'true', self::get_switch_url( $item_id, $item, $subscription ) ) );
exit;
}
} else {
WC_Subscriptions::add_notice( $subscribed_notice, 'notice' );
break;
}
}
}
}
}
}
}
/**
* When switching between grouped products, the Switch Subscription will take people to the grouped product's page. From there if they
* click through to the individual products, they lose the switch.
*
* WooCommerce added a filter so we're able to modify the permalinks, passing through the switch parameter to the individual products'
* pages.
*
* @param string $permalink The permalink of the product belonging to that group
*/
public static function add_switch_query_arg_grouped( $permalink ) {
if ( isset( $_GET['switch-subscription'] ) ) {
$permalink = self::add_switch_query_args( $_GET['switch-subscription'], $_GET['item'], $permalink );
}
return $permalink;
}
/**
* Slightly more awkward implementation for WooCommerce versions that do not have the woocommerce_grouped_product_list_link filter.
*
* @param string $permalink The permalink of the product belonging to the group
* @param object $post a WP_Post object
* @return string modified string with the query arg present
*/
public static function add_switch_query_arg_post_link( $permalink, $post ) {
if ( ! isset( $_GET['switch-subscription'] ) || ! is_main_query() || ! is_product() || 'product' !== $post->post_type ) {
return $permalink;
}
$product = wc_get_product( $post );
if ( ! $product->is_type( 'subscription' ) ) {
return $permalink;
}
return self::add_switch_query_args( $_GET['switch-subscription'], $_GET['item'], $permalink );
}
/**
* Add Switch settings to the Subscription's settings page.
*
* @since 1.4
*/
public static function add_settings( $settings ) {
array_splice( $settings, 12, 0, array(
array(
'name' => __( 'Switching', 'woocommerce-subscriptions' ),
'type' => 'title',
// translators: placeholders are opening and closing link tags
'desc' => sprintf( __( 'Allow subscribers to switch (upgrade or downgrade) between different subscriptions. %sLearn more%s.', 'woocommerce-subscriptions' ), '<a href="' . esc_url( 'http://docs.woothemes.com/document/subscriptions/switching-guide/' ) . '">', '</a>' ),
'id' => WC_Subscriptions_Admin::$option_prefix . '_switch_settings',
),
array(
'name' => __( 'Allow Switching', 'woocommerce-subscriptions' ),
'desc' => __( 'Allow subscribers to switch between subscriptions combined in a grouped product, different variations of a Variable subscription or don\'t allow switching.', 'woocommerce-subscriptions' ),
'tip' => '',
'id' => WC_Subscriptions_Admin::$option_prefix . '_allow_switching',
'css' => 'min-width:150px;',
'default' => 'no',
'type' => 'select',
'options' => array(
'no' => _x( 'Never', 'when to allow a setting', 'woocommerce-subscriptions' ),
'variable' => _x( 'Between Subscription Variations', 'when to allow switching', 'woocommerce-subscriptions' ),
'grouped' => _x( 'Between Grouped Subscriptions', 'when to allow switching', 'woocommerce-subscriptions' ),
'variable_grouped' => _x( 'Between Both Variations & Grouped Subscriptions', 'when to allow switching', 'woocommerce-subscriptions' ),
),
'desc_tip' => true,
),
array(
'name' => __( 'Prorate Recurring Payment', 'woocommerce-subscriptions' ),
'desc' => __( 'When switching to a subscription with a different recurring payment or billing period, should the price paid for the existing billing period be prorated when switching to the new subscription?', 'woocommerce-subscriptions' ),
'tip' => '',
'id' => WC_Subscriptions_Admin::$option_prefix . '_apportion_recurring_price',
'css' => 'min-width:150px;',
'default' => 'no',
'type' => 'select',
'options' => array(
'no' => _x( 'Never', 'when to allow a setting', 'woocommerce-subscriptions' ),
'virtual-upgrade' => _x( 'For Upgrades of Virtual Subscription Products Only', 'when to prorate recurring fee when switching', 'woocommerce-subscriptions' ),
'yes-upgrade' => _x( 'For Upgrades of All Subscription Products', 'when to prorate recurring fee when switching', 'woocommerce-subscriptions' ),
'virtual' => _x( 'For Upgrades & Downgrades of Virtual Subscription Products Only', 'when to prorate recurring fee when switching', 'woocommerce-subscriptions' ),
'yes' => _x( 'For Upgrades & Downgrades of All Subscription Products', 'when to prorate recurring fee when switching', 'woocommerce-subscriptions' ),
),
'desc_tip' => true,
),
array(
'name' => __( 'Prorate Sign up Fee', 'woocommerce-subscriptions' ),
'desc' => __( 'When switching to a subscription with a sign up fee, you can require the customer pay only the gap between the existing subscription\'s sign up fee and the new subscription\'s sign up fee (if any).', 'woocommerce-subscriptions' ),
'tip' => '',
'id' => WC_Subscriptions_Admin::$option_prefix . '_apportion_sign_up_fee',
'css' => 'min-width:150px;',
'default' => 'no',
'type' => 'select',
'options' => array(
'no' => _x( 'Never (do not charge a sign up fee)', 'when to prorate signup fee when switching', 'woocommerce-subscriptions' ),
'full' => _x( 'Never (charge the full sign up fee)', 'when to prorate signup fee when switching', 'woocommerce-subscriptions' ),
'yes' => _x( 'Always', 'when to prorate signup fee when switching','woocommerce-subscriptions' ),
),
'desc_tip' => true,
),
array(
'name' => __( 'Prorate Subscription Length', 'woocommerce-subscriptions' ),
'desc' => __( 'When switching to a subscription with a length, you can take into account the payments already completed by the customer when determining how many payments the subscriber needs to make for the new subscription.', 'woocommerce-subscriptions' ),
'tip' => '',
'id' => WC_Subscriptions_Admin::$option_prefix . '_apportion_length',
'css' => 'min-width:150px;',
'default' => 'no',
'type' => 'select',
'options' => array(
'no' => _x( 'Never', 'when to allow a setting', 'woocommerce-subscriptions' ),
'virtual' => _x( 'For Virtual Subscription Products Only', 'when to prorate first payment / subscription length', 'woocommerce-subscriptions' ),
'yes' => _x( 'For All Subscription Products', 'when to prorate first payment / subscription length', 'woocommerce-subscriptions' ),
),
'desc_tip' => true,
),
array(
'name' => __( 'Switch Button Text', 'woocommerce-subscriptions' ),
'desc' => __( 'Customise the text displayed on the button next to the subscription on the subscriber\'s account page. The default is "Switch Subscription", but you may wish to change this to "Upgrade" or "Change Subscription".', 'woocommerce-subscriptions' ),
'tip' => '',
'id' => WC_Subscriptions_Admin::$option_prefix . '_switch_button_text',
'css' => 'min-width:150px;',
'default' => __( 'Upgrade or Downgrade', 'woocommerce-subscriptions' ),
'type' => 'text',
'desc_tip' => true,
),
array( 'type' => 'sectionend', 'id' => WC_Subscriptions_Admin::$option_prefix . '_switch_settings' ),
) );
return $settings;
}
/**
* Adds an Upgrade/Downgrade link on the View Subscription page for each item that can be switched.
*
* @param int $item_id The order item ID of a subscription line item
* @param array $item An order line item
* @param object $subscription A WC_Subscription object
* @since 1.4
*/
public static function print_switch_link( $item_id, $item, $subscription ) {
if ( 'shop_subscription' !== $subscription->order_type || ! self::can_item_be_switched_by_user( $item, $subscription ) ) {
return;
}
$switch_url = esc_url( self::get_switch_url( $item_id, $item, $subscription ) );
$switch_text = get_option( WC_Subscriptions_Admin::$option_prefix . '_switch_button_text', __( 'Upgrade or Downgrade', 'woocommerce-subscriptions' ) );
$switch_link = sprintf( '<a href="%s" class="wcs-switch-link button">%s</a>', $switch_url, $switch_text );
echo wp_kses( apply_filters( 'woocommerce_subscriptions_switch_link', $switch_link, $item_id, $item, $subscription ), array( 'a' => array( 'href' => array(), 'title' => array(), 'class' => array() ) ) );
}
/**
* The link for switching a subscription - the product page for variable subscriptions, or grouped product page for grouped subscriptions.
*
* @param WC_Subscription $subscription An instance of WC_Subscription
* @param array $item An order item on the subscription
* @since 2.0
*/
public static function get_switch_url( $item_id, $item, $subscription ) {
if ( ! is_object( $subscription ) ) {
$subscription = wcs_get_subscription( $subscription );
}
$product = wc_get_product( $item['product_id'] );
// Grouped product
if ( 0 !== $product->post->post_parent ) {
$switch_url = get_permalink( $product->post->post_parent );
} else {
$switch_url = get_permalink( $product->id );
}
$switch_url = self::add_switch_query_args( $subscription->id, $item_id, $switch_url );
return apply_filters( 'woocommerce_subscriptions_switch_url', $switch_url, $item_id, $item, $subscription );
}
/**
* Add the switch parameters to a URL for a given subscription and item.
*
* @param int $subscription_id A subscription's post ID
* @param int $item_id The order item ID of a subscription line item
* @param string $permalink The permalink of the product
* @since 2.0
*/
protected static function add_switch_query_args( $subscription_id, $item_id, $permalink ) {
// manually add a nonce because we can't use wp_nonce_url() (it would escape the URL)
$permalink = add_query_arg( array( 'switch-subscription' => absint( $subscription_id ), 'item' => absint( $item_id ), '_wcsnonce' => wp_create_nonce( 'wcs_switch_request' ) ), $permalink );
return apply_filters( 'woocommerce_subscriptions_add_switch_query_args', $permalink, $subscription_id, $item_id );
}
/**
* Check if a given item on a subscription can be switched.
*
* For an item to be switchable, switching must be enabled, and the item must be for a variable subscription or
* part of a grouped product (at the time the check is made, not at the time the subscription was purchased)
*
* The subscription must also be active or on-hold and use manual renewals or use a payment method which supports cancellation.
*
* @param array $item An order item on the subscription
* @param WC_Subscription $subscription An instance of WC_Subscription
* @since 2.0
*/
public static function can_item_be_switched( $item, $subscription = null ) {
$product_id = wcs_get_canonical_product_id( $item );
if ( 'line_item' == $item['type'] && wcs_is_product_switchable_type( $product_id ) ) {
$is_product_switchable = true;
} else {
$is_product_switchable = false;
}
if ( $subscription->has_status( 'active' ) && 0 !== $subscription->get_date( 'last_payment' ) ) {
$is_subscription_switchable = true;
} else {
$is_subscription_switchable = false;
}
if ( $subscription->payment_method_supports( 'subscription_amount_changes' ) && $subscription->payment_method_supports( 'subscription_date_changes' ) ) {
$can_subscription_be_updated = true;
} else {
$can_subscription_be_updated = false;
}
if ( $is_product_switchable && $is_subscription_switchable && $can_subscription_be_updated ) {
$item_can_be_switch = true;
} else {
$item_can_be_switch = false;
}
return apply_filters( 'woocommerce_subscriptions_can_item_be_switched', $item_can_be_switch, $item, $subscription );
}
/**
* Check if a given item on a subscription can be switched by a given user.
*
* @param array $item An order item on the subscription
* @param WC_Subscription $subscription An instance of WC_Subscription
* @param int $user_id (optional) The ID of a user. Defaults to currently logged in user.
* @since 2.0
*/
public static function can_item_be_switched_by_user( $item, $subscription, $user_id = 0 ) {
if ( 0 === $user_id ) {
$user_id = get_current_user_id();
}
$item_can_be_switched = false;
if ( user_can( $user_id, 'switch_shop_subscription', $subscription->id ) && self::can_item_be_switched( $item, $subscription ) ) {
$item_can_be_switched = true;
}
return apply_filters( 'woocommerce_subscriptions_can_item_be_switched_by_user', $item_can_be_switched, $item, $subscription );
}
/**
* If the order being generated is for switching a subscription, keep a record of some of the switch
* routines meta against the order.
*
* @param int $order_id The ID of a WC_Order object
* @param array $posted The data posted on checkout
* @since 1.4
*/
public static function add_order_meta( $order_id, $posted ) {
$switches = self::cart_contains_switches();
if ( false !== $switches ) {
foreach ( $switches as $switch_details ) {
add_post_meta( $order_id, '_subscription_switch', $switch_details['subscription_id'] );
}
}
}
/**
* To prorate sign-up fee and recurring amounts correctly when the customer switches a subscription multiple times, keep a record of the
* amount for each on the order item.
*
* @since 2.0
*/
public static function add_order_item_meta( $order_item_id, $cart_item, $cart_item_key ) {
if ( isset( $cart_item['subscription_switch'] ) ) {
if ( $switches = self::cart_contains_switches() ) {
foreach ( $switches as $switch_item_key => $switch_details ) {
if ( $cart_item_key == $switch_item_key ) {
wc_add_order_item_meta( $order_item_id, '_switched_subscription_sign_up_fee_prorated', ( isset( WC()->cart->cart_contents[ $cart_item_key ]['data']->subscription_sign_up_fee_prorated ) ? WC()->cart->cart_contents[ $cart_item_key ]['data']->subscription_sign_up_fee_prorated : 0 ), true );
wc_add_order_item_meta( $order_item_id, '_switched_subscription_price_prorated', ( isset( WC()->cart->cart_contents[ $cart_item_key ]['data']->subscription_price_prorated ) ? WC()->cart->cart_contents[ $cart_item_key ]['data']->subscription_price_prorated : 0 ), true );
}
}
}
}
}
/**
* Subscription items on a new billing schedule are left to be added as new subscriptions, but we also
* want to keep a record of them being a switch, so we do that here.
*
* @since 2.0
*/
public static function set_subscription_item_meta( $item_id, $cart_item, $cart_item_key ) {
if ( isset( $cart_item['subscription_switch'] ) ) {
if ( $switches = self::cart_contains_switches() ) {
foreach ( $switches as $switch_item_key => $switch_details ) {
if ( $cart_item_key == $switch_item_key ) {
wc_add_order_item_meta( $item_id, '_switched_subscription_item_id', $switch_details['item_id'], true );
wc_add_order_item_meta( $switch_details['item_id'], '_switched_subscription_new_item_id', $item_id, true );
}
}
}
}
}
/**
* Handle any subscription switch items on checkout (and before WC_Subscriptions_Checkout::process_checkout())
*
* If the item is on the same billing schedule as the old subscription (and the next payment date is the same) or the
* item is the only item on the subscription, the subscription item will be updated (and a note left on the order).
* If the item is on a new billing schedule and there are other items on the existing subscription, the old item will
* be removed and the new item will be added to a new subscription by @see WC_Subscriptions_Checkout::process_checkout()
*
* @param int $order_id The post_id of a shop_order post/WC_Order object
* @param array $posted_data The data posted on checkout
* @since 2.0
*/
public static function process_checkout( $order_id, $posted_data ) {
global $wpdb;
if ( ! WC_Subscriptions_Cart::cart_contains_subscription() ) {
return;
}
$order = wc_get_order( $order_id );
try {
// Start transaction if available
$wpdb->query( 'START TRANSACTION' );
foreach ( WC()->cart->recurring_carts as $recurring_cart_key => $recurring_cart ) {
foreach ( $recurring_cart->get_cart() as $cart_item_key => $cart_item ) {
if ( ! isset( $cart_item['subscription_switch']['subscription_id'] ) ) {
continue;
}
$subscription = wcs_get_subscription( $cart_item['subscription_switch']['subscription_id'] );
$existing_item = wcs_get_order_item( $cart_item['subscription_switch']['item_id'], $subscription );
// If there are no more payments due on the subscription, because we're in the last billing period, we need to use the subscription's expiration date, not next payment date
if ( 0 == ( $next_payment_timestamp = $subscription->get_time( 'next_payment' ) ) ) {
$next_payment_timestamp = $subscription->get_time( 'end' );
}
if ( $cart_item['data']->subscription_period != $subscription->billing_period || $cart_item['data']->subscription_period_interval != $subscription->billing_interval ) {
$is_different_billing_schedule = true;
} else {
$is_different_billing_schedule = false;
}
if ( 0 !== $cart_item['subscription_switch']['first_payment_timestamp'] && $next_payment_timestamp !== $cart_item['subscription_switch']['first_payment_timestamp'] ) {
$is_different_payment_date = true;
} elseif ( 0 !== $cart_item['subscription_switch']['first_payment_timestamp'] && 0 == $subscription->get_time( 'next_payment' ) ) { // if the subscription doesn't have a next payment but the switched item does
$is_different_payment_date = true;
} else {
$is_different_payment_date = false;
}
if ( date( 'Y-m-d', strtotime( $recurring_cart->end_date ) ) !== date( 'Y-m-d', $subscription->get_time( 'end' ) ) ) {
$is_different_length = true;
} else {
$is_different_length = false;
}
// WC_Abstract_Order::get_item_count() uses quantites, not just line item rows
if ( 1 == count( $subscription->get_items() ) ) {
$is_single_item_subscription = true;
} else {
$is_single_item_subscription = false;
}
// If the item is on the same schedule, we can just add it to the new subscription and remove the old item
if ( $is_single_item_subscription || ( false === $is_different_billing_schedule && false === $is_different_payment_date && false === $is_different_length ) ) {
// Add the new item
$item_id = WC_Subscriptions_Checkout::add_cart_item( $subscription, $cart_item, $cart_item_key );
// Remove the item from the cart so that WC_Subscriptions_Checkout doesn't add it to a subscription
if ( 1 == count( WC()->cart->recurring_carts[ $recurring_cart_key ]->get_cart() ) ) {
// If this is the only item in the cart, clear out recurring carts so WC_Subscriptions_Checkout doesn't try to create an empty subscription
unset( WC()->cart->recurring_carts[ $recurring_cart_key ] );
} else {
unset( WC()->cart->recurring_carts[ $recurring_cart_key ]->cart_contents[ $cart_item_key ] );
}
do_action( 'woocommerce_subscription_item_switched', $order, $subscription, $item_id, $cart_item['subscription_switch']['item_id'] );
}
// If the old subscription has just one item, we can safely update its billing schedule
if ( $is_single_item_subscription ) {
if ( $is_different_billing_schedule ) {
update_post_meta( $subscription->id, '_billing_period', $cart_item['data']->subscription_period );
update_post_meta( $subscription->id, '_billing_interval', absint( $cart_item['data']->subscription_period_interval ) );
}
$updated_dates = array();
if ( '1' == $cart_item['data']->subscription_length || ( 0 != $recurring_cart->end_date && date( 'Y-m-d H:i:s', $cart_item['subscription_switch']['first_payment_timestamp'] ) >= $recurring_cart->end_date ) ) {
$subscription->delete_date( 'next_payment' );
} else if ( $is_different_payment_date ) {
$updated_dates['next_payment'] = date( 'Y-m-d H:i:s', $cart_item['subscription_switch']['first_payment_timestamp'] );
}
if ( $is_different_length ) {
$updated_dates['end'] = $recurring_cart->end_date;
}
if ( ! empty( $updated_dates ) ) {
$subscription->update_dates( $updated_dates );
}
}
// Remove the old item from the subscription but don't delete it completely by changing its line item type to "line_item_switched"
wc_update_order_item( $cart_item['subscription_switch']['item_id'], array( 'order_item_type' => 'line_item_switched' ) );
$old_item_name = wcs_get_order_item_name( $existing_item, array( 'attributes' => true ) );
$new_item_name = wcs_get_cart_item_name( $cart_item, array( 'attributes' => true ) );
// translators: 1$: old item name, 2$: new item name when switching
$subscription->add_order_note( sprintf( _x( 'Customer switched from: %1$s to %2$s.', 'used in order notes', 'woocommerce-subscriptions' ), $old_item_name, $new_item_name ) );
// Change the shipping
self::update_shipping_methods( $subscription, $recurring_cart );
// Finally, change the addresses but only if they've changed
self::maybe_update_subscription_address( $order, $subscription );
$subscription->calculate_totals();
}
}
// Everything seems to be in order
$wpdb->query( 'COMMIT' );
} catch ( Exception $e ) {
// There was an error adding the subscription, roll back and delete pending order for switch
$wpdb->query( 'ROLLBACK' );
wp_delete_post( $order_id, true );
throw $e;
}
}
/**
* Update shipping method on the subscription if the order changed anything
*
* @param WC_Order $order The new order
* @param WC_Subscription $subscription The original subscription
* @param WC_Cart $recurring_cart A recurring cart
*/
public static function update_shipping_methods( $subscription, $recurring_cart ) {
// First, archive all the shipping methods
foreach ( $subscription->get_shipping_methods() as $shipping_method_id => $shipping_method ) {
wc_update_order_item( $shipping_method_id, array( 'order_item_type' => 'shipping_switched' ) );
}
// Then zero the order_shipping total so we have a clean slate to add to
$subscription->order_shipping = 0;
WC_Subscriptions_Checkout::add_shipping( $subscription, $recurring_cart );
// Now update subscription object order_shipping to reflect updated values so it doesn't stay 0
$subscription->order_shipping = get_post_meta( $subscription->id, '_order_shipping', true );
}
/**
* Updates address on the subscription if one of them is changed.
*
* @param WC_Order $order The new order
* @param WC_Subscription $subscription The original subscription
*/
public static function maybe_update_subscription_address( $order, $subscription ) {
if ( method_exists( $subscription, 'get_address' ) ) {
$order_billing = $order->get_address( 'billing' );
$order_shipping = $order->get_address();
$subscription_billing = $subscription->get_address( 'billing' );
$subscription_shipping = $subscription->get_address();
} else {
$order_billing = wcs_get_order_address( $order, 'billing' );
$order_shipping = wcs_get_order_address( $order );
$subscription_billing = wcs_get_order_address( $subscription, 'billing' );
$subscription_shipping = wcs_get_order_address( $subscription );
}
$subscription->set_address( array_diff_assoc( $order_billing, $subscription_billing ), 'billing' );
$subscription->set_address( array_diff_assoc( $order_shipping, $subscription_shipping ), 'shipping' );
}
/**
* If the subscription purchased in an order has since been switched, include a link to the order placed to switch the subscription
* in the "Related Orders" meta box (displayed on the Edit Order screen).
*
* @param WC_Order $order The current order.
* @since 1.4
*/
public static function switch_order_meta_box_rows( $post ) {
$subscriptions = array();
$switched_ids = array();
$orders = array();
// On the subscription page, just show related orders
if ( wcs_is_subscription( $post->ID ) ) {
// Select the orders which switched item/s from this subscription
$orders = wcs_get_switch_orders_for_subscription( $post->ID );
foreach ( $orders as $order ) {
$orders[ $order->id ]->relationship = __( 'Switch Order', 'woocommerce-subscriptions' );
}
// Select the subscriptions which had item/s switched to this subscription by its parent order
if ( ! empty( $post->post_parent ) ) {
$switched_ids = get_post_meta( $post->post_parent, '_subscription_switch' );
}
// On the Edit Order screen, show any subscriptions with items switched by this order
} else {
$switched_ids = get_post_meta( $post->ID, '_subscription_switch', false );
}
foreach ( $switched_ids as $subscription_id ) {
$subscription = wcs_get_subscription( $subscription_id );
$subscription->relationship = __( 'Switched Subscription', 'woocommerce-subscriptions' );
$orders[ $subscription_id ] = $subscription;
}
foreach ( $orders as $order ) {
include( plugin_dir_path( WC_Subscriptions::$plugin_file ) . 'includes/admin/meta-boxes/views/html-related-orders-row.php' );
}
}
/**
* Check if the cart includes any items which are to switch an existing subscription's item.
*
* @return bool|array Returns all the items that are for a switching or false if none of the items in the cart are a switch request.
* @since 2.0
*/
public static function cart_contains_switches() {
$subscription_switches = false;
if ( is_admin() && ( ! defined( 'DOING_AJAX' ) || false == DOING_AJAX ) ) {
return $subscription_switches;
}
if ( isset( WC()->cart ) ) {
// We use WC()->cart->cart_contents instead of WC()->cart->get_cart() to prevent recursion caused when get_cart_from_session() too early is called ref: https://github.com/woothemes/woocommerce/commit/1f3365f2066b1e9d7e84aca7b1d7e89a6989c213
foreach ( WC()->cart->cart_contents as $cart_item_key => $cart_item ) {
if ( isset( $cart_item['subscription_switch'] ) ) {
if ( wcs_is_subscription( $cart_item['subscription_switch']['subscription_id'] ) ) {
$subscription_switches[ $cart_item_key ] = $cart_item['subscription_switch'];
} else {
WC()->cart->remove_cart_item( $cart_item_key );
WC_Subscriptions::add_notice( __( 'Your cart contained an invalid subscription switch request. It has been removed.', 'woocommerce-subscriptions' ), 'error' );
}
}
}
}
return $subscription_switches;
}
/**
* Check if the cart includes any items which are to switch an existing subscription's item.
*
* @param int|object Either a product ID (not variation ID) or product object
* @return bool True if the cart contains a switch fora given product, or false if it does not.
* @since 2.0
*/
public static function cart_contains_switch_for_product( $product ) {
$product_id = ( is_object( $product ) ) ? $product->id : $product;
$switch_items = self::cart_contains_switches();
$switch_product_ids = array();
if ( false !== $switch_items ) {
// Check if there is a switch for this variation product
foreach ( $switch_items as $switch_item_details ) {
$switch_product = wc_get_product( wcs_get_order_items_product_id( $switch_item_details['item_id'] ) );
// If the switch is for a grouped product, we need to check the other products grouped with this one
if ( 0 !== $product->post->post_parent ) {
$switch_product_ids = array_unique( array_merge( $switch_product_ids, wc_get_product( $product->post->post_parent )->get_children() ) );
} else {
$switch_product_ids[] = $switch_product->id;
}
}
}
return in_array( $product_id, $switch_product_ids );
}
/**
* When a product is added to the cart, check if it is being added to switch a subscription and if so,
* make sure it's valid (i.e. not the same subscription).
*
* @since 1.4
*/
public static function validate_switch_request( $is_valid, $product_id, $quantity, $variation_id = '' ) {
$error_message = '';
try {
if ( ! isset( $_GET['switch-subscription'] ) ) {
return $is_valid;
}
if ( empty( $_GET['_wcsnonce'] ) || ! wp_verify_nonce( $_GET['_wcsnonce'], 'wcs_switch_request' ) ) {
return false;
}
$subscription = wcs_get_subscription( $_GET['switch-subscription'] );
$item_id = absint( $_GET['item'] );
$item = wcs_get_order_item( $item_id, $subscription );
// Check if the chosen variation's attributes are different to the existing subscription's attributes (to support switching between a "catch all" variation)
if ( empty( $item ) ) {
throw new Exception( __( 'We can not find your old subscription item.', 'woocommerce-subscriptions' ) );
} else {
$identical_attributes = true;
foreach ( $_POST as $key => $value ) {
if ( false !== strpos( $key, 'attribute_' ) && ! empty( $item[ str_replace( 'attribute_', '', $key ) ] ) && $item[ str_replace( 'attribute_', '', $key ) ] != $value ) {
$identical_attributes = false;
break;
}
}
if ( $product_id == $item['product_id'] && ( empty( $variation_id ) || ( $variation_id == $item['variation_id'] && true == $identical_attributes ) ) && $quantity == $item['qty'] ) {
throw new Exception( __( 'You can not switch to the same subscription.', 'woocommerce-subscriptions' ) );
}
// Also remove any existing items in the cart for switching this item (but don't make the switch invalid)
if ( $is_valid ) {
$existing_switch_items = self::cart_contains_switches();
if ( false !== $existing_switch_items ) {
foreach ( $existing_switch_items as $cart_item_key => $switch_item ) {
if ( $switch_item['item_id'] == $item_id ) {
WC()->cart->remove_cart_item( $cart_item_key );
}
}
}
}
}
} catch ( Exception $e ) {
$error_message = $e->getMessage();
}
$error_message = apply_filters( 'woocommerce_subscriptions_switch_error_message', $error_message, $product_id, $quantity, $variation_id, $subscription, $item );
if ( ! empty( $error_message ) ) {
wc_add_notice( $error_message, 'error' );
$is_valid = false;
}
return apply_filters( 'woocommerce_subscriptions_is_switch_valid', $is_valid, $product_id, $quantity, $variation_id, $subscription, $item );
}
/**
* When a subscription switch is added to the cart, store a record of pertinent meta about the switch.
*
* @since 1.4
*/
public static function set_switch_details_in_cart( $cart_item_data, $product_id, $variation_id ) {
try {
if ( ! isset( $_GET['switch-subscription'] ) ) {
return $cart_item_data;
}
$subscription = wcs_get_subscription( $_GET['switch-subscription'] );
// Requesting a switch for someone elses subscription
if ( ! current_user_can( 'switch_shop_subscription', $subscription->id ) ) {
WC_Subscriptions::add_notice( __( 'You can not switch this subscription. It appears you do not own the subscription.', 'woocommerce-subscriptions' ), 'error' );
WC()->cart->empty_cart( true );
wp_redirect( get_permalink( $subscription['product_id'] ) );
exit();
}
$item = wcs_get_order_item( absint( $_GET['item'] ), $subscription );
// Else it's a valid switch
$product = wc_get_product( $item['product_id'] );
$child_products = ( 0 !== $product->post->post_parent ) ? wc_get_product( $product->post->post_parent )->get_children() : array();
if ( $product_id != $item['product_id'] && ! in_array( $item['product_id'], $child_products ) ) {
return $cart_item_data;
}
$next_payment_timestamp = $subscription->get_time( 'next_payment' );
// If there are no more payments due on the subscription, because we're in the last billing period, we need to use the subscription's expiration date, not next payment date
if ( false == $next_payment_timestamp ) {
$next_payment_timestamp = $subscription->get_time( 'end' );
}
$cart_item_data['subscription_switch'] = array(
'subscription_id' => $subscription->id,
'item_id' => absint( $_GET['item'] ),
'next_payment_timestamp' => $next_payment_timestamp,
'upgraded_or_downgraded' => '',
);
return $cart_item_data;
} catch ( Exception $e ) {
WC_Subscriptions::add_notice( __( 'There was an error locating the switch details.', 'woocommerce-subscriptions' ), 'error' );
WC()->cart->empty_cart( true );
wp_redirect( get_permalink( wc_get_page_id( 'cart' ) ) );
exit();
}
}
/**
* Get the recurring amounts values from the session
*
* @since 1.4
*/
public static function get_cart_from_session( $cart_item_data, $cart_item, $key ) {
if ( isset( $cart_item['subscription_switch'] ) ) {
$cart_item_data['subscription_switch'] = $cart_item['subscription_switch'];
}
return $cart_item_data;
}
/**
* Make sure the sign-up fee on a subscription line item takes into account sign-up fees paid for switching.
*
* @param WC_Subscription $subscription
* @return array $cart_item Details of an item in WC_Cart for a switch
* @since 2.0
*/
public static function subscription_items_sign_up_fee( $sign_up_fee, $line_item, $subscription ) {
// This item has never been switched, no need to add anything
if ( ! isset( $line_item['switched_subscription_item_id'] ) ) {
return $sign_up_fee;
}
// First add any sign-up fees for previously switched items
$switched_line_items = $subscription->get_items( 'line_item_switched' );
foreach ( $switched_line_items as $switched_line_item_id => $switched_line_item ) {
if ( $line_item['switched_subscription_item_id'] == $switched_line_item_id ) {
$sign_up_fee += $subscription->get_items_sign_up_fee( $switched_line_item ); // Recursion: get the sign up fee for this item's old item and the sign up fee for that item's old item and the sign up fee for that item's old item and the sign up fee for that item's old item ...
break; // Each item can only be switched once
}
}
// Now add any sign-up fees paid in switch orders
foreach ( wcs_get_switch_orders_for_subscription( $subscription->id ) as $order ) {
foreach ( $order->get_items() as $order_item_id => $order_item ) {
if ( wcs_get_canonical_product_id( $line_item ) == wcs_get_canonical_product_id( $order_item ) ) {
// We only want to add the amount of the line total which was for a prorated sign-up fee, not the amount for a prorated recurring amount
if ( isset( $order_item['switched_subscription_sign_up_fee_prorated'] ) ) {
if ( $order_item['switched_subscription_sign_up_fee_prorated'] > 0 ) {
$sign_up_proportion = $order_item['switched_subscription_sign_up_fee_prorated'] / ( $order_item['switched_subscription_price_prorated'] + $order_item['switched_subscription_sign_up_fee_prorated'] );
} else {
$sign_up_proportion = 0;
}
} else {
$sign_up_proportion = 1;
}
$sign_up_fee += round( $order_item['line_total'] * $sign_up_proportion, 2 );
}
}
}
return $sign_up_fee;
}
/**
* Set the subscription prices to be used in calculating totals by @see WC_Subscriptions_Cart::calculate_subscription_totals()
*
* @since 2.0
*/
public static function calculate_prorated_totals( $cart ) {
if ( false === self::cart_contains_switches() ) {
return;
}
// Maybe charge an initial amount to account for upgrading from a cheaper subscription
$apportion_recurring_price = get_option( WC_Subscriptions_Admin::$option_prefix . '_apportion_recurring_price', 'no' );
$apportion_sign_up_fee = get_option( WC_Subscriptions_Admin::$option_prefix . '_apportion_sign_up_fee', 'no' );
$apportion_length = get_option( WC_Subscriptions_Admin::$option_prefix . '_apportion_length', 'no' );
foreach ( WC()->cart->get_cart() as $cart_item_key => $cart_item ) {
if ( ! isset( $cart_item['subscription_switch']['subscription_id'] ) ) {
continue;
}
$subscription = wcs_get_subscription( $cart_item['subscription_switch']['subscription_id'] );
$existing_item = wcs_get_order_item( $cart_item['subscription_switch']['item_id'], $subscription );
if ( empty( $existing_item ) ) {
WC()->cart->remove_cart_item( $cart_item_key );
continue;
}
$item_data = $cart_item['data'];
$product_id = wcs_get_canonical_product_id( $cart_item );
$product = wc_get_product( $product_id );
$is_virtual_product = $product->is_virtual();
// Set when the first payment and end date for the new subscription should occur
WC()->cart->cart_contents[ $cart_item_key ]['subscription_switch']['first_payment_timestamp'] = $cart_item['subscription_switch']['next_payment_timestamp'];
WC()->cart->cart_contents[ $cart_item_key ]['subscription_switch']['end_timestamp'] = $end_timestamp = strtotime( WC_Subscriptions_Product::get_expiration_date( $product_id, $subscription->get_date( 'last_payment' ) ) );
// Add any extra sign up fees required to switch to the new subscription
if ( 'yes' == $apportion_sign_up_fee ) {
// Because product add-ons etc. don't apply to sign-up fees, it's safe to use the product's sign-up fee value rather than the cart item's
$sign_up_fee_due = $product->subscription_sign_up_fee;
$sign_up_fee_paid = $subscription->get_items_sign_up_fee( $existing_item, 'inclusive_of_tax' );
// Make sure total prorated sign-up fee is prorated across total amount of sign-up fee so that customer doesn't get extra discounts
if ( $cart_item['quantity'] > $existing_item['qty'] ) {
$sign_up_fee_paid = ( $sign_up_fee_paid * $existing_item['qty'] ) / $cart_item['quantity'];
}
WC()->cart->cart_contents[ $cart_item_key ]['data']->subscription_sign_up_fee = max( $sign_up_fee_due - $sign_up_fee_paid, 0 );
WC()->cart->cart_contents[ $cart_item_key ]['data']->subscription_sign_up_fee_prorated = WC()->cart->cart_contents[ $cart_item_key ]['data']->subscription_sign_up_fee;
} elseif ( 'no' == $apportion_sign_up_fee ) { // $0 the initial sign-up fee
WC()->cart->cart_contents[ $cart_item_key ]['data']->subscription_sign_up_fee = 0;
}
// Get the current subscription's last payment date
$last_payment_timestamp = $subscription->get_time( 'last_payment' );
$days_since_last_payment = floor( ( gmdate( 'U' ) - $last_payment_timestamp ) / ( 60 * 60 * 24 ) );
// Get the current subscription's next payment date
$next_payment_timestamp = $cart_item['subscription_switch']['next_payment_timestamp'];
$days_until_next_payment = ceil( ( $next_payment_timestamp - gmdate( 'U' ) ) / ( 60 * 60 * 24 ) );
// If the subscription contains a synced product and the next payment is actually the first payment, determine the days in the "old" cycle from the subscription object
if ( WC_Subscriptions_Synchroniser::subscription_contains_synced_product( $subscription->id ) && WC_Subscriptions_Synchroniser::calculate_first_payment_date( $product, 'timestamp', $subscription->get_date( 'start' ) ) == $next_payment_timestamp ) {
$days_in_old_cycle = wcs_get_days_in_cycle( $subscription->billing_period, $subscription->billing_interval );
} else {
// Find the number of days between the two
$days_in_old_cycle = $days_until_next_payment + $days_since_last_payment;
}
// Find the actual recurring amount charged for the old subscription (we need to use the '_recurring_line_total' meta here rather than '_subscription_recurring_amount' because we want the recurring amount to include extra from extensions, like Product Add-ons etc.)
$old_recurring_total = $existing_item['line_total'];
if ( 'yes' == $subscription->prices_include_tax || true === $subscription->prices_include_tax ) { // WC_Abstract_Order::$prices_include_tax can be set to true in __construct() or to 'yes' in populate()
$old_recurring_total += $existing_item['line_tax'];
}
// Find the $price per day for the old subscription's recurring total
$old_price_per_day = $old_recurring_total / $days_in_old_cycle;
// Find the price per day for the new subscription's recurring total
// If the subscription uses the same billing interval & cycle as the old subscription,
if ( $item_data->subscription_period == $subscription->billing_period && $item_data->subscription_period_interval == $subscription->billing_interval ) {
$days_in_new_cycle = $days_in_old_cycle; // Use $days_in_old_cycle to make sure they're consistent
} else {
// We need to figure out the price per day for the new subscription based on its billing schedule
$days_in_new_cycle = wcs_get_days_in_cycle( $item_data->subscription_period, $item_data->subscription_period_interval );
}
// We need to use the cart items price to ensure we include extras added by extensions like Product Add-ons
$new_price_per_day = ( $item_data->price * $cart_item['quantity'] ) / $days_in_new_cycle;
if ( $old_price_per_day < $new_price_per_day ) {
WC()->cart->cart_contents[ $cart_item_key ]['subscription_switch']['upgraded_or_downgraded'] = 'upgraded';
} elseif ( $old_price_per_day > $new_price_per_day && $new_price_per_day >= 0 ) {
WC()->cart->cart_contents[ $cart_item_key ]['subscription_switch']['upgraded_or_downgraded'] = 'downgraded';
}
// Now lets see if we should add a prorated amount to the sign-up fee (for upgrades) or extend the next payment date (for downgrades)
if ( in_array( $apportion_recurring_price, array( 'yes', 'yes-upgrade' ) ) || ( in_array( $apportion_recurring_price, array( 'virtual', 'virtual-upgrade' ) ) && $is_virtual_product ) ) {
// If the customer is upgrading, we may need to add a gap payment to the sign-up fee or to reduce the pre-paid period (or both)
if ( $old_price_per_day < $new_price_per_day ) {
// The new subscription may be more expensive, but it's also on a shorter billing cycle, so reduce the next pre-paid term
if ( $days_in_old_cycle > $days_in_new_cycle ) {
// Find out how many days at the new price per day the customer would receive for the total amount already paid
// (e.g. if the customer paid $10 / month previously, and was switching to a $5 / week subscription, she has pre-paid 14 days at the new price)
$pre_paid_days = 0;
do {
$pre_paid_days++;
$new_total_paid = $pre_paid_days * $new_price_per_day;
} while ( $new_total_paid < $old_recurring_total );
// If the total amount the customer has paid entitles her to more days at the new price than she has received, there is no gap payment, just shorten the pre-paid term the appropriate number of days
if ( $days_since_last_payment < $pre_paid_days ) {
WC()->cart->cart_contents[ $cart_item_key ]['subscription_switch']['first_payment_timestamp'] = $last_payment_timestamp + ( $pre_paid_days * 60 * 60 * 24 );
// If the total amount the customer has paid entitles her to the same or less days at the new price then start the new subscription from today
} else {
WC()->cart->cart_contents[ $cart_item_key ]['subscription_switch']['first_payment_timestamp'] = 0;
}
} else {
$extra_to_pay = $days_until_next_payment * ( $new_price_per_day - $old_price_per_day );
// when calculating a subscription with one length (no more next payment date and the end date may have been pushed back) we need to pay for those extra days at the new price per day between the old next payment date and new end date
if ( 1 == $item_data->subscription_length ) {
$days_to_new_end = floor( ( $end_timestamp - $next_payment_timestamp ) / ( 60 * 60 * 24 ) );
if ( $days_to_new_end > 0 ) {
$extra_to_pay += $days_to_new_end * $new_price_per_day;
}
}
// We need to find the per item extra to pay so we can set it as the sign-up fee (WC will then multiply it by the quantity)
$extra_to_pay = $extra_to_pay / $cart_item['quantity'];
// Keep a record of the two separate amounts so we store these and calculate future switch amounts correctly
WC()->cart->cart_contents[ $cart_item_key ]['data']->subscription_sign_up_fee_prorated = WC()->cart->cart_contents[ $cart_item_key ]['data']->subscription_sign_up_fee;
WC()->cart->cart_contents[ $cart_item_key ]['data']->subscription_price_prorated = round( $extra_to_pay, 2 );
WC()->cart->cart_contents[ $cart_item_key ]['data']->subscription_sign_up_fee += round( $extra_to_pay, 2 );
}
// If the customer is downgrading, set the next payment date and maybe extend it if downgrades are prorated
} elseif ( $old_price_per_day > $new_price_per_day && $new_price_per_day > 0 ) {
$old_total_paid = $old_price_per_day * $days_until_next_payment;
$new_total_paid = $new_price_per_day;
// if downgrades are apportioned, extend the next payment date for n more days
if ( in_array( $apportion_recurring_price, array( 'virtual', 'yes' ) ) ) {
// Find how many more days at the new lower price it takes to exceed the amount already paid
for ( $days_to_add = 0; $new_total_paid <= $old_total_paid; $days_to_add++ ) {
$new_total_paid = $days_to_add * $new_price_per_day;
}
$days_to_add -= $days_until_next_payment;
} else {
$days_to_add = 0;
}
WC()->cart->cart_contents[ $cart_item_key ]['subscription_switch']['first_payment_timestamp'] = $next_payment_timestamp + ( $days_to_add * 60 * 60 * 24 );
} // The old price per day == the new price per day, no need to change anything
if ( WC()->cart->cart_contents[ $cart_item_key ]['subscription_switch']['first_payment_timestamp'] != $cart_item['subscription_switch']['next_payment_timestamp'] ) {
WC()->cart->cart_contents[ $cart_item_key ]['subscription_switch']['recurring_payment_prorated'] = true;
}
}
// Finally, if we need to make sure the initial total doesn't include any recurring amount, we can by spoofing a free trial
if ( 0 != WC()->cart->cart_contents[ $cart_item_key ]['subscription_switch']['first_payment_timestamp'] ) {
WC()->cart->cart_contents[ $cart_item_key ]['data']->subscription_trial_length = 1;
}
if ( 'yes' == $apportion_length || ( 'virtual' == $apportion_length && $is_virtual_product ) ) {
$base_length = WC_Subscriptions_Product::get_length( $product_id );
$completed_payments = $subscription->get_completed_payment_count();
$length_remaining = $base_length - $completed_payments;
// Default to the base length if more payments have already been made than this subscription requires
if ( $length_remaining <= 0 ) {
$length_remaining = $base_length;
}
WC()->cart->cart_contents[ $cart_item_key ]['data']->subscription_length = $length_remaining;
}
}
}
/**
* Make sure when displaying the first payment date for a switched subscription, the date takes into
* account the switch (i.e. prepaid days and possibly a downgrade).
*
* @since 2.0
*/
public static function recurring_cart_next_payment_date( $first_renewal_date, $cart ) {
foreach ( $cart->get_cart() as $cart_item_key => $cart_item ) {
if ( isset( $cart_item['subscription_switch']['first_payment_timestamp'] ) ) {
$first_renewal_date = ( '1' != $cart_item['data']->subscription_length ) ? date( 'Y-m-d H:i:s', $cart_item['subscription_switch']['first_payment_timestamp'] ) : 0;
}
}
return $first_renewal_date;
}
/**
* Make sure the end date of the switched subscription starts after already paid term
*
* @since 2.0
*/
public static function recurring_cart_end_date( $end_date, $cart, $product ) {
if ( 0 !== $end_date ) {
foreach ( $cart->get_cart() as $cart_item_key => $cart_item ) {
if ( isset( $cart_item['subscription_switch']['subscription_id'] ) && isset( $cart_item['data'] ) && $product == $cart_item['data'] ) {
$next_payment_time = isset( $cart_item['subscription_switch']['first_payment_timestamp'] ) ? $cart_item['subscription_switch']['first_payment_timestamp'] : 0;
$end_timestamp = WC()->cart->cart_contents[ $cart_item_key ]['subscription_switch']['end_timestamp'];
// if the subscription is length 1 and prorated, we want to use the prorated the next payment date as the end date
if ( 1 == $cart_item['data']->subscription_length && 0 !== $next_payment_time && isset( $cart_item['subscription_switch']['recurring_payment_prorated'] ) ) {
$end_date = date( 'Y-m-d H:i:s', $next_payment_time );
// if the subscription is more than 1 (and not 0) and we have a next payment date (prorated or not) we want to calculate the new end date from that
} elseif ( 0 !== $next_payment_time && $cart_item['data']->subscription_length > 1 ) {
// remove trial period on the switched subscription when calculating the new end date
$trial_length = $cart_item['data']->subscription_trial_length;
$cart_item['data']->subscription_trial_length = 0;
$end_date = WC_Subscriptions_Product::get_expiration_date( $cart_item['data'], date( 'Y-m-d H:i:s', $next_payment_time ) );
// add back the trial length if it has been spoofed
$cart_item['data']->subscription_trial_length = $trial_length;
// elseif fallback to using the end date set on the cart item
} elseif ( ! empty( $end_timestamp ) ) {
$end_date = date( 'Y-m-d H:i:s', $end_timestamp );
}
break;
}
}
}
return $end_date;
}
/**
* Make sure that a switch items cart key is based on it's first renewal date, not the date calculated for the product.
*
* @since 2.0
*/
public static function get_recurring_cart_key( $cart_key, $cart_item ) {
if ( isset( $cart_item['subscription_switch']['first_payment_timestamp'] ) ) {
remove_filter( 'woocommerce_subscriptions_recurring_cart_key', __METHOD__, 10, 2 );
$cart_key = WC_Subscriptions_Cart::get_recurring_cart_key( $cart_item, $cart_item['subscription_switch']['first_payment_timestamp'] );
add_filter( 'woocommerce_subscriptions_recurring_cart_key', __METHOD__, 10, 2 );
}
return $cart_key;
}
/**
* If the current request is to switch subscriptions, don't show a product's free trial period (because there is no
* free trial for subscription switches) and also if the length is being prorateed, don't display the length until
* checkout.
*
* @since 1.4
*/
public static function customise_product_string_inclusions( $inclusions, $product ) {
if ( isset( $_GET['switch-subscription'] ) || self::cart_contains_switch_for_product( $product ) ) {
$inclusions['trial_length'] = false;
$apportion_length = get_option( WC_Subscriptions_Admin::$option_prefix . '_apportion_length', 'no' );
$apportion_sign_up_fee = get_option( WC_Subscriptions_Admin::$option_prefix . '_apportion_sign_up_fee', 'no' );
if ( 'yes' == $apportion_length || ( 'virtual' == $apportion_length && $product->is_virtual() ) ) {
$inclusions['subscription_length'] = false;
}
if ( 'no' === $apportion_sign_up_fee ) {
$inclusions['sign_up_fee'] = false;
}
}
return $inclusions;
}
/**
* If a product is being marked as not purchasable because it is limited and the customer has a subscription,
* but the current request is to switch the subscription, then mark it as purchasable.
*
* @since 1.4.4
* @return bool
*/
public static function is_purchasable( $is_purchasable, $product ) {
$product_key = ! empty( $product->variation_id ) ? $product->variation_id : $product->id;
if ( ! isset( self::$is_purchasable_cache[ $product_key ] ) ) {
if ( false === $is_purchasable && wcs_is_product_switchable_type( $product ) && WC_Subscriptions_Product::is_subscription( $product->id ) && 'no' != $product->limit_subscriptions && is_user_logged_in() && wcs_user_has_subscription( 0, $product->id, $product->limit_subscriptions ) ) {
// Adding to cart from the product page
if ( isset( $_GET['switch-subscription'] ) ) {
$is_purchasable = true;
// Validating when restring cart from session
} elseif ( self::cart_contains_switches() ) {
$is_purchasable = true;
// Restoring cart from session, so need to check the cart in the session (self::cart_contains_subscription_switch() only checks the cart)
} elseif ( isset( WC()->session->cart ) ) {
foreach ( WC()->session->cart as $cart_item_key => $cart_item ) {
if ( $product->id == $cart_item['product_id'] && isset( $cart_item['subscription_switch'] ) ) {
$is_purchasable = true;
break;
}
}
}
}
self::$is_purchasable_cache[ $product_key ] = $is_purchasable;
}
return self::$is_purchasable_cache[ $product_key ];
}
/**
* Automatically set a switch order's status to complete (even if the items require shipping because
* the order is simply a record of the switch and not indicative of an item needing to be shipped)
*
* @since 1.5
*/
public static function subscription_switch_autocomplete( $new_order_status, $order_id ) {
if ( 'processing' == $new_order_status && wcs_order_contains_switch( $order_id ) ) {
$order = wc_get_order( $order_id );
$all_switched = true;
if ( 0 == $order->get_total() ) {
foreach ( $order->get_items() as $item ) {
if ( ! isset( $item['switched_subscription_price_prorated'] ) ) {
$all_switched = false;
break;
}
}
if ( $all_switched || 1 == count( $order->get_items() ) ) {
$new_order_status = 'completed';
}
}
}
return $new_order_status;
}
/**
* Do not carry over switch related meta data to renewal orders.
*
* @since 1.5.4
*/
public static function remove_renewal_order_meta_query( $order_meta_query ) {
$order_meta_query .= " AND `meta_key` NOT IN ('_subscription_switch')";
return $order_meta_query;
}
/**
* Make the switch process persist even if the subscription product has Product Addons that need to be set.
*
* @since 1.5.6
*/
public static function addons_add_to_cart_url( $add_to_cart_url ) {
if ( isset( $_GET['switch-subscription'] ) && false === strpos( $add_to_cart_url, 'switch-subscription' ) ) {
$add_to_cart_url = self::add_switch_query_args( $_GET['switch-subscription'], $_GET['item'], $add_to_cart_url );
}
return $add_to_cart_url;
}
/**
* Checks if a product can be switched based on it's type and the types which can be switched
*
* @since 1.5.21
*/
public static function is_product_of_switchable_type( $product ) {
_deprecated_function( __METHOD__, '2.0.7', 'wcs_is_product_switchable_type' );
$allow_switching = false;
$switch_setting = get_option( WC_Subscriptions_Admin::$option_prefix . '_allow_switching', 'no' );
// does the current switch setting allow switching for variable or variable_grouped
if ( 'variable_grouped' == $switch_setting || ( $product->is_type( array( 'variable-subscription', 'subscription_variation' ) ) && 'variable' == $switch_setting ) || ( 'grouped' == $switch_setting && ( $product->is_type( 'grouped' ) || 0 !== $product->post->post_parent ) ) ) {
$allow_switching = true;
}
return $allow_switching;
}
/**
* Check if a given subscription item was for upgrading/downgrading an existing item.
*
* @since 2.0
*/
protected static function is_item_switched( $item ) {
$is_item_switched = isset( $item['switched'] ) ? true : false;
return $is_item_switched;
}
/**
* Do not display switch related order item meta keys unless Subscriptions is in debug mode.
*
* @since 2.0
*/
public static function hidden_order_itemmeta( $hidden_meta_keys ) {
if ( ! defined( 'WCS_DEBUG' ) || true !== WCS_DEBUG ) {
$hidden_meta_keys = array_merge( $hidden_meta_keys, array(
'_switched_subscription_item_id',
'_switched_subscription_new_item_id',
'_switched_subscription_sign_up_fee_prorated',
'_switched_subscription_price_prorated',
)
);
}
return $hidden_meta_keys;
}
/**
* Stop the switch link from printing on email templates
*
* @since 2.0
*/
public static function remove_print_switch_link() {
remove_filter( 'woocommerce_order_item_meta_end', __CLASS__ . '::print_switch_link', 10 );
}
/**
* Add the print switch link filter back after the subscription items table has been created in email template
*
* @since 2.0
*/
public static function add_print_switch_link( $table_content ) {
add_filter( 'woocommerce_order_item_meta_end', __CLASS__ . '::print_switch_link', 10, 3 );
return $table_content;
}
/**
* Filter the WC_Subscription::get_related_orders() method to include switch orders.
*
* @since 2.0
*/
public static function add_related_orders( $related_orders, $subscription, $return_fields, $order_type ) {
if ( in_array( $order_type, array( 'all', 'switch' ) ) ) {
$switch_orders = wcs_get_switch_orders_for_subscription( $subscription->id );
if ( 'all' == $return_fields ) {
$related_orders += $switch_orders;
} else {
foreach ( $switch_orders as $order_id => $order ) {
$related_orders[ $order_id ] = $order_id;
}
}
// This will change the ordering to be by ID instead of the default of date
krsort( $related_orders );
}
return $related_orders;
}
/**
* Add the cart item upgrade/downgrade/crossgrade direction for display
*
* @since 2.0
*/
public static function add_cart_item_switch_direction( $product_subtotal, $cart_item, $cart_item_key ) {
if ( ! empty( $cart_item['subscription_switch'] ) ) {
switch ( $cart_item['subscription_switch']['upgraded_or_downgraded'] ) {
case 'downgraded' :
$direction = _x( 'Downgrade', 'a switch order', 'woocommerce-subscriptions' );
break;
case 'upgraded' :
$direction = _x( 'Upgrade', 'a switch order', 'woocommerce-subscriptions' );
break;
default :
$direction = _x( 'Crossgrade', 'a switch order', 'woocommerce-subscriptions' );
break;
}
// translators: %1: product subtotal, %2: HTML span tag, %3: direction (upgrade, downgrade, crossgrade), %4: closing HTML span tag
$product_subtotal = sprintf( _x( '%1$s %2$s(%3$s)%4$s', 'product subtotal string', 'woocommerce-subscriptions' ), $product_subtotal, '<span class="subscription-switch-direction">', $direction, '</span>' );
}
return $product_subtotal;
}
/**
* Creates a 2.0 updated version of the "subscriptions_switched" callback for developers to hook onto.
*
* The subscription passed to the new `woocommerce_subscriptions_switched_item` callback is strictly the subscription
* to which the `$new_order_item` belongs to; this may be a new or the original subscription.
*
* @since 2.0.5
* @param WC_Order $order
*/
public static function maybe_add_switched_callback( $order ) {
if ( wcs_order_contains_switch( $order ) ) {
$subscriptions = wcs_get_subscriptions_for_order( $order );
foreach ( $subscriptions as $subscription ) {
foreach ( $subscription->get_items() as $new_order_item ) {
if ( isset( $new_order_item['switched_subscription_item_id'] ) ) {
$product_id = wcs_get_canonical_product_id( $new_order_item );
// we need to check if the switch order contains the line item that has just been switched so that we don't call the hook on items that were previously switched in another order
foreach ( $order->get_items() as $order_item ) {
if ( wcs_get_canonical_product_id( $order_item ) == $product_id ) {
do_action( 'woocommerce_subscriptions_switched_item', $subscription, $new_order_item, WC_Subscriptions_Order::get_item_by_id( $new_order_item['switched_subscription_item_id'] ) );
break;
}
}
}
}
}
}
}
/**
* Revoke download permissions granted on the old switch item.
*
* @since 2.0.9
* @param WC_Subscription $subscription
* @param array $new_item
* @param array $old_item
*/
public static function remove_download_permissions_after_switch( $subscription, $new_item, $old_item ) {
if ( ! is_object( $subscription ) ) {
$subscription = wcs_get_subscription( $subscription );
}
$product_id = wcs_get_canonical_product_id( $old_item );
WCS_Download_Handler::revoke_downloadable_file_permission( $product_id, $subscription->id, $subscription->customer_user );
}
/** Deprecated Methods **/
/**
* Don't allow switched subscriptions to be cancelled.
*
* @param bool $subscription_can_be_changed
* @param array $subscription A subscription of the form created by @see WC_Subscriptions_Manager::get_subscription()
* @since 1.4
* @deprecated 2.0
*/
public static function can_subscription_be_cancelled( $subscription_can_be_changed, $subscription ) {
_deprecated_function( __METHOD__, '2.0' );
if ( 'switched' == $subscription['status'] ) {
$subscription_can_be_changed = false;
}
return $subscription_can_be_changed;
}
/**
* Adds a "Switch" button to the "My Subscriptions" table for those subscriptions can be upgraded/downgraded.
*
* @param array $all_actions The $subscription_key => $actions array with all actions that will be displayed for a subscription on the "My Subscriptions" table
* @param array $subscriptions All of a given users subscriptions that will be displayed on the "My Subscriptions" table
* @since 1.4
* @deprecated 2.0
*/
public static function add_switch_button( $all_actions, $subscriptions ) {
_deprecated_function( __METHOD__, '2.0', __CLASS__ . '::print_switch_button( $subscription, $item )' );
$user_id = get_current_user_id();
foreach ( $all_actions as $subscription_key => $actions ) {
if ( WC_Subscriptions_Manager::can_subscription_be_changed_to( 'new-subscription', $subscription_key, $user_id ) ) {
$all_actions[ $subscription_key ] = array(
'switch' => array(
'url' => self::get_switch_link( $subscription_key ),
'name' => get_option( WC_Subscriptions_Admin::$option_prefix . '_switch_button_text', __( 'Upgrade or Downgrade', 'woocommerce-subscriptions' ) ),
),
) + $all_actions[ $subscription_key ];
}
}
return $all_actions;
}
/**
* The link for switching a subscription - the product page for variable subscriptions, or grouped product page for grouped subscriptions.
*
* @param string $subscription_key A subscription key of the form created by @see self::get_subscription_key()
* @since 1.4
* @deprecated 2.0
*/
public static function get_switch_link( $subscription_key ) {
_deprecated_function( __METHOD__, '2.0', __CLASS__ . '::get_switch_url( $item_id, $item, $subscription )' );
}
/**
* Add a 'new-subscription' handler to the WC_Subscriptions_Manager::can_subscription_be_changed_to() function.
*
* For the subscription to be switchable, switching must be enabled, and the subscription must:
* - be active or on-hold
* - be a variable subscription or part of a grouped product (at the time the check is made, not at the time the subscription was purchased)
* - be using manual renewals or use a payment method which supports cancellation
*
* @param bool $subscription_can_be_changed Flag of whether the subscription can be changed to
* @param string $new_status_or_meta The status or meta data you want to change the subscription to. Can be 'active', 'on-hold', 'cancelled', 'expired', 'trash', 'deleted', 'failed', 'AMQPChannel to the 'woocommerce_can_subscription_be_changed_to' filter.
* @param object $args Set of values used in @see WC_Subscriptions_Manager::can_subscription_be_changed_to() for determining if a subscription can be changed
* @since 1.4
* @deprecated 2.0
*/
public static function can_subscription_be_changed_to( $subscription_can_be_changed, $new_status_or_meta, $args ) {
_deprecated_function( __METHOD__, '2.0', __CLASS__ . '::can_item_be_switched( $item, $subscription )' );
return false;
}
/**
* Check if the cart includes a request to switch a subscription.
*
* @return bool Returns true if any item in the cart is a subscription switch request, otherwise, false.
* @since 1.4
* @deprecated 2.0
*/
public static function cart_contains_subscription_switch() {
_deprecated_function( __METHOD__, '2.0', __CLASS__ . '::cart_contains_switches()' );
$cart_contains_subscription_switch = self::cart_contains_switches();
// For backward compatiblity, only send the first switch item, not all of them
if ( false !== $cart_contains_subscription_switch ) {
$cart_contains_subscription_switch = array_pop( $cart_contains_subscription_switch );
}
return $cart_contains_subscription_switch;
}
/**
* Previously, we used a trial period to make sure totals are calculated correctly (i.e. order total does not include any recurring
* amounts) but we didn't want switched subscriptions to actually have a trial period, so reset the value on the order after checkout.
*
* This is all redundant now that trial period isn't stored on a subscription item. The first payment date will be used instead.
*
* @since 1.4
* @deprecated 2.0
*/
public static function fix_order_item_meta( $item_id, $values ) {
_deprecated_function( __METHOD__, '2.0' );
}
/**
* Add the next payment date to the end of the subscription to clarify when the new rate will be charged
*
* @since 1.4
* @deprecated 2.0
*/
public static function customise_subscription_price_string( $subscription_string ) {
_deprecated_function( __METHOD__, '2.0' );
}
/**
* Never display the trial period for a subscription switch (we're only setting it to calculate correct totals)
*
* @since 1.4
* @deprecated 2.0
*/
public static function customise_cart_subscription_string_details( $subscription_details ) {
_deprecated_function( __METHOD__, '2.0' );
return $subscription_details;
}
/**
* Make sure when calculating the first payment date for a switched subscription, the date takes into
* account the switch (i.e. prepaid days and possibly a downgrade).
*
* @since 1.4
* @deprecated 2.0
*/
public static function calculate_first_payment_date( $next_payment_date, $order, $product_id, $type ) {
_deprecated_function( __METHOD__, '2.0' );
return self::get_first_payment_date( $next_payment_date, WC_Subscriptions_Manager::get_subscription_key( $order->id, $product_id ), $order->user_id, $type );
}
/**
* Make sure anything requesting the first payment date for a switched subscription receives a date which
* takes into account the switch (i.e. prepaid days and possibly a downgrade).
*
* This is necessary as the self::calculate_first_payment_date() is not called when the subscription is active
* (which it isn't until the first payment is completed and the subscription is activated).
*
* @deprecated 2.0
*/
public static function get_first_payment_date( $next_payment_date, $subscription_key, $user_id, $type ) {
_deprecated_function( __METHOD__, '2.0' );
$subscription = wcs_get_subscription_from_key( $subscription_key );
if ( $subscription->has_status( 'active' ) && ! empty( $subscription->order ) && wcs_order_contains_switch( $subscription->order->id ) && 1 >= $subscription->get_completed_payment_count() ) {
$first_payment_timestamp = get_post_meta( $subscription->order->id, '_switched_subscription_first_payment_timestamp', true );
if ( 0 != $first_payment_timestamp ) {
$next_payment_date = ( 'mysql' == $type ) ? date( 'Y-m-d H:i:s', $first_payment_timestamp ) : $first_payment_timestamp;
}
}
return $next_payment_date;
}
/**
* Add an i18n'ified string for the "switched" subscription status.
*
* @since 1.4
* @deprecated 2.0
*/
public static function add_switched_status_string( $status_string ) {
_deprecated_function( __METHOD__, '2.0' );
if ( 'switched' === strtolower( $status_string ) ) {
$status_string = _x( 'Switched', 'Subscription status', 'woocommerce-subscriptions' );
}
return $status_string;
}
/**
* Set the subscription prices to be used in calculating totals by @see WC_Subscriptions_Cart::calculate_subscription_totals()
*
* @since 1.4
* @deprecated 2.0
*/
public static function maybe_set_apporitioned_totals( $total ) {
_deprecated_function( __METHOD__, '2.0', __CLASS__ . '::calculate_prorated_totals()' );
return $total;
}
/**
* If the subscription purchased in an order has since been switched, include a link to the order placed to switch the subscription
* in the "Related Orders" meta box (displayed on the Edit Order screen).
*
* @param WC_Order $order The current order.
* @since 1.4
* @deprecated 2.0
*/
public static function switch_order_meta_box_section( $order ) {
_deprecated_function( __METHOD__, '2.0' );
}
/**
* After payment is completed on an order for switching a subscription, complete the switch.
*
* @param WC_Order|int $order A WC_Order object or ID of a WC_Order order.
* @since 1.4
* @deprecated 2.0
*/
public static function maybe_complete_switch( $order_id ) {
_deprecated_function( __METHOD__, '2.0' );
}
/**
* Check if a given order was created to switch a subscription.
*
* @param WC_Order $order An order to check.
* @return bool Returns true if the order switched a subscription, otherwise, false.
* @since 1.4
*/
public static function order_contains_subscription_switch( $order_id ) {
_deprecated_function( __METHOD__, '2.0', 'wcs_order_contains_switch( $order_id )' );
return wcs_order_contains_switch( $order_id );
}
}
WC_Subscriptions_Switcher::init();