class-wc-subscriptions-admin.php
63.8 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
<?php
/**
* Subscriptions Admin Class
*
* Adds a Subscription setting tab and saves subscription settings. Adds a Subscriptions Management page. Adds
* Welcome messages and pointers to streamline learning process for new users.
*
* @package WooCommerce Subscriptions
* @subpackage WC_Subscriptions_Admin
* @category Class
* @author Brent Shepherd
* @since 1.0
*/
class WC_Subscriptions_Admin {
/**
* The WooCommerce settings tab name
*
* @since 1.0
*/
public static $tab_name = 'subscriptions';
/**
* The prefix for subscription settings
*
* @since 1.0
*/
public static $option_prefix = 'woocommerce_subscriptions';
/**
* Store an instance of the list table
*
* @since 1.4.6
*/
private static $subscriptions_list_table;
/**
* Store an instance of the list table
*
* @since 2.0
*/
private static $found_related_orders = false;
/**
* Bootstraps the class and hooks required actions & filters.
*
* @since 1.0
*/
public static function init() {
// Add subscriptions to the product select box
add_filter( 'product_type_selector', __CLASS__ . '::add_subscription_products_to_select' );
// Add subscription pricing fields on edit product page
add_action( 'woocommerce_product_options_general_product_data', __CLASS__ . '::subscription_pricing_fields' );
// Add subscription shipping options on edit product page
add_action( 'woocommerce_product_options_shipping', __CLASS__ . '::subscription_shipping_fields' );
// Add advanced subscription options on edit product page
add_action( 'woocommerce_product_options_reviews', __CLASS__ . '::subscription_advanced_fields' );
// And also on the variations section
add_action( 'woocommerce_product_after_variable_attributes', __CLASS__ . '::variable_subscription_pricing_fields', 10, 3 );
// Add bulk edit actions for variable subscription products
add_action( 'woocommerce_variable_product_bulk_edit_actions', __CLASS__ . '::variable_subscription_bulk_edit_actions', 10 );
// Save subscription meta when a subscription product is changed via bulk edit
add_action( 'woocommerce_product_bulk_edit_save', __CLASS__ . '::bulk_edit_save_subscription_meta', 10 );
// Save subscription meta only when a subscription product is saved, can't run on the "'woocommerce_process_product_meta_' . $product_type" action because we need to override some WC defaults
add_action( 'save_post', __CLASS__ . '::save_subscription_meta', 11 );
add_action( 'save_post', __CLASS__ . '::save_variable_subscription_meta', 11 );
// Save variable subscription meta
add_action( 'woocommerce_process_product_meta_variable-subscription', __CLASS__ . '::process_product_meta_variable_subscription' ); // WC < 2.4
add_action( 'woocommerce_ajax_save_product_variations', __CLASS__ . '::process_product_meta_variable_subscription' );
add_action( 'product_variation_linked', __CLASS__ . '::set_variation_meta_defaults_on_bulk_add' );
add_filter( 'woocommerce_settings_tabs_array', __CLASS__ . '::add_subscription_settings_tab', 50 );
add_action( 'woocommerce_settings_tabs_subscriptions', __CLASS__ . '::subscription_settings_page' );
add_action( 'woocommerce_update_options_' . self::$tab_name, __CLASS__ . '::update_subscription_settings' );
add_filter( 'manage_users_columns', __CLASS__ . '::add_user_columns', 11, 1 );
add_filter( 'manage_users_custom_column', __CLASS__ . '::user_column_values', 11, 3 ); // Fire after default to avoid being broken by plugins #doing_it_wrong
add_action( 'admin_enqueue_scripts', __CLASS__ . '::enqueue_styles_scripts' );
add_action( 'woocommerce_admin_field_informational', __CLASS__ . '::add_informational_admin_field' );
add_filter( 'posts_where', __CLASS__ . '::filter_orders' );
add_action( 'admin_notices', __CLASS__ . '::display_renewal_filter_notice' );
add_shortcode( 'subscriptions', __CLASS__ . '::do_subscriptions_shortcode' );
add_filter( 'set-screen-option', __CLASS__ . '::set_manage_subscriptions_screen_option', 10, 3 );
add_filter( 'woocommerce_debug_posting', __CLASS__ . '::add_system_status_items' );
add_filter( 'woocommerce_payment_gateways_setting_columns', __CLASS__ . '::payment_gateways_rewewal_column' );
add_action( 'woocommerce_payment_gateways_setting_column_renewals', __CLASS__ . '::payment_gateways_rewewal_support' );
// Do not display formatted order total on the Edit Order administration screen
add_filter( 'woocommerce_get_formatted_order_total', __CLASS__ . '::maybe_remove_formatted_order_total_filter', 0, 2 );
}
/**
* Add the 'subscriptions' product type to the WooCommerce product type select box.
*
* @param array Array of Product types & their labels, excluding the Subscription product type.
* @return array Array of Product types & their labels, including the Subscription product type.
* @since 1.0
*/
public static function add_subscription_products_to_select( $product_types ) {
$product_types['subscription'] = __( 'Simple Subscription', 'woocommerce-subscriptions' );
$product_types['variable-subscription'] = __( 'Variable Subscription', 'woocommerce-subscriptions' );
return $product_types;
}
/**
* Output the subscription specific pricing fields on the "Edit Product" admin page.
*
* @since 1.0
*/
public static function subscription_pricing_fields() {
global $post;
// Set month as the default billing period
if ( ! $subscription_period = get_post_meta( $post->ID, '_subscription_period', true ) ) {
$subscription_period = 'month';
}
echo '<div class="options_group subscription_pricing show_if_subscription">';
// Subscription Price
woocommerce_wp_text_input( array(
'id' => '_subscription_price',
'class' => 'wc_input_subscription_price',
// translators: placeholder is a currency symbol / code
'label' => sprintf( __( 'Subscription Price (%s)', 'woocommerce-subscriptions' ), get_woocommerce_currency_symbol() ),
'placeholder' => _x( 'e.g. 9.90', 'example price', 'woocommerce-subscriptions' ),
'type' => 'text',
'custom_attributes' => array(
'step' => 'any',
'min' => '0',
),
) );
// Subscription Period Interval
woocommerce_wp_select( array(
'id' => '_subscription_period_interval',
'class' => 'wc_input_subscription_period_interval',
'label' => __( 'Subscription Periods', 'woocommerce-subscriptions' ),
'options' => wcs_get_subscription_period_interval_strings(),
)
);
// Billing Period
woocommerce_wp_select( array(
'id' => '_subscription_period',
'class' => 'wc_input_subscription_period',
'label' => __( 'Billing Period', 'woocommerce-subscriptions' ),
'value' => $subscription_period,
'description' => _x( 'for', 'for in "Every month _for_ 12 months"', 'woocommerce-subscriptions' ),
'options' => wcs_get_subscription_period_strings(),
)
);
// Subscription Length
woocommerce_wp_select( array(
'id' => '_subscription_length',
'class' => 'wc_input_subscription_length',
'label' => __( 'Subscription Length', 'woocommerce-subscriptions' ),
'options' => wcs_get_subscription_ranges( $subscription_period ),
)
);
// Sign-up Fee
woocommerce_wp_text_input( array(
'id' => '_subscription_sign_up_fee',
'class' => 'wc_input_subscription_intial_price',
// translators: %s is a currency symbol / code
'label' => sprintf( __( 'Sign-up Fee (%s)', 'woocommerce-subscriptions' ), get_woocommerce_currency_symbol() ),
'placeholder' => _x( 'e.g. 9.90', 'example price', 'woocommerce-subscriptions' ),
'description' => __( 'Optionally include an amount to be charged at the outset of the subscription. The sign-up fee will be charged immediately, even if the product has a free trial or the payment dates are synced.', 'woocommerce-subscriptions' ),
'desc_tip' => true,
'type' => 'text',
'custom_attributes' => array(
'step' => 'any',
'min' => '0',
),
) );
// Trial Length
woocommerce_wp_text_input( array(
'id' => '_subscription_trial_length',
'class' => 'wc_input_subscription_trial_length',
'label' => __( 'Free Trial', 'woocommerce-subscriptions' ),
) );
// Trial Period
woocommerce_wp_select( array(
'id' => '_subscription_trial_period',
'class' => 'wc_input_subscription_trial_period',
'label' => __( 'Subscription Trial Period', 'woocommerce-subscriptions' ),
'options' => wcs_get_available_time_periods(),
// translators: placeholder is trial period validation message if passed an invalid value (e.g. "Trial period can not exceed 4 weeks")
'description' => sprintf( _x( 'An optional period of time to wait before charging the first recurring payment. Any sign up fee will still be charged at the outset of the subscription. %s', 'Trial period dropdown\'s description in pricing fields', 'woocommerce-subscriptions' ), self::get_trial_period_validation_message() ),
'desc_tip' => true,
'value' => WC_Subscriptions_Product::get_trial_period( $post->ID ), // Explicitly set value in to ensure backward compatibility
) );
do_action( 'woocommerce_subscriptions_product_options_pricing' );
wp_nonce_field( 'wcs_subscription_meta', '_wcsnonce' );
echo '</div>';
echo '<div class="show_if_subscription clear"></div>';
}
/**
* Output subscription shipping options on the "Edit Product" admin screen
*
* @since 2.0
*/
public static function subscription_shipping_fields() {
global $post;
echo '</div>';
echo '<div class="options_group subscription_one_time_shipping show_if_subscription show_if_variable-subscription">';
// Only one Subscription per customer
woocommerce_wp_checkbox( array(
'id' => '_subscription_one_time_shipping',
'label' => __( 'One Time Shipping', 'woocommerce-subscriptions' ),
'description' => __( 'Shipping for subscription products is normally charged on the initial order and all renewal orders. Enable this to only charge shipping once on the initial order. Note: for shipping to be charged on the initial order, the subscription must not have a free trial.', 'woocommerce-subscriptions' ),
'desc_tip' => true,
) );
do_action( 'woocommerce_subscriptions_product_options_shipping' );
}
/**
* Output advanced subscription options on the "Edit Product" admin screen
*
* @since 1.3.5
*/
public static function subscription_advanced_fields() {
global $post;
echo '</div>';
echo '<div class="options_group limit_subscription show_if_subscription show_if_variable-subscription">';
// Only one Subscription per customer
woocommerce_wp_select( array(
'id' => '_subscription_limit',
'label' => __( 'Limit Subscription', 'woocommerce-subscriptions' ),
// translators: placeholders are opening and closing link tags
'description' => sprintf( __( 'Only allow a customer to have one subscription to this product. %sLearn more%s.', 'woocommerce-subscriptions' ), '<a href="http://docs.woothemes.com/document/subscriptions/store-manager-guide/#limit-subscription">', '</a>' ),
'options' => array(
'no' => __( 'Do not limit', 'woocommerce-subscriptions' ),
'active' => __( 'Limit to one active subscription', 'woocommerce-subscriptions' ),
'any' => __( 'Limit to one of any status', 'woocommerce-subscriptions' ),
),
) );
do_action( 'woocommerce_subscriptions_product_options_advanced' );
}
/**
* Output the subscription specific pricing fields on the "Edit Product" admin page.
*
* @since 1.3
*/
public static function variable_subscription_pricing_fields( $loop, $variation_data, $variation ) {
global $thepostid;
// Set month as the default billing period
if ( ! $subscription_period = get_post_meta( $variation->ID, '_subscription_period', true ) ) {
$subscription_period = 'month';
}
// When called via Ajax
if ( ! function_exists( 'woocommerce_wp_text_input' ) ) {
require_once( WC()->plugin_path() . '/admin/post-types/writepanels/writepanels-init.php' );
}
if ( ! isset( $thepostid ) ) {
$thepostid = $variation->post_parent;
}
include( plugin_dir_path( WC_Subscriptions::$plugin_file ) . 'templates/admin/html-variation-price.php' );
wp_nonce_field( 'wcs_subscription_variations', '_wcsnonce_save_variations', false );
do_action( 'woocommerce_variable_subscription_pricing', $loop, $variation_data, $variation );
}
/**
* Output extra options in the Bulk Edit select box for editing Subscription terms.
*
* @since 1.3
*/
public static function variable_subscription_bulk_edit_actions() {
global $post;
if ( WC_Subscriptions_Product::is_subscription( $post->ID ) ) : ?>
<optgroup label="<?php esc_attr_e( 'Subscription Pricing', 'woocommerce-subscriptions' ); ?>">
<option value="variable_subscription_sign_up_fee"><?php esc_html_e( 'Subscription Sign-up Fee', 'woocommerce-subscriptions' ); ?></option>
<option value="variable_subscription_period_interval"><?php esc_html_e( 'Subscription Billing Interval', 'woocommerce-subscriptions' ); ?></option>
<option value="variable_subscription_period"><?php esc_html_e( 'Subscription Period', 'woocommerce-subscriptions' ); ?></option>
<option value="variable_subscription_length"><?php esc_html_e( 'Subscription Length', 'woocommerce-subscriptions' ); ?></option>
<option value="variable_subscription_trial_length"><?php esc_html_e( 'Free Trial Length', 'woocommerce-subscriptions' ); ?></option>
<option value="variable_subscription_trial_period"><?php esc_html_e( 'Free Trial Period', 'woocommerce-subscriptions' ); ?></option>
</optgroup>
<?php endif;
}
/**
* Save meta data for simple subscription product type when the "Edit Product" form is submitted.
*
* @param array Array of Product types & their labels, excluding the Subscription product type.
* @return array Array of Product types & their labels, including the Subscription product type.
* @since 1.0
*/
public static function save_subscription_meta( $post_id ) {
if ( empty( $_POST['_wcsnonce'] ) || ! wp_verify_nonce( $_POST['_wcsnonce'], 'wcs_subscription_meta' ) || ! isset( $_POST['product-type'] ) || ! in_array( $_POST['product-type'], apply_filters( 'woocommerce_subscription_product_types', array( WC_Subscriptions::$name ) ) ) ) {
return;
}
$subscription_price = isset( $_REQUEST['_subscription_price'] ) ? wc_format_decimal( $_REQUEST['_subscription_price'] ) : '';
$sale_price = wc_format_decimal( $_REQUEST['_sale_price'] );
update_post_meta( $post_id, '_subscription_price', $subscription_price );
// Set sale details - these are ignored by WC core for the subscription product type
update_post_meta( $post_id, '_regular_price', $subscription_price );
update_post_meta( $post_id, '_sale_price', $sale_price );
$date_from = ( isset( $_POST['_sale_price_dates_from'] ) ) ? strtotime( $_POST['_sale_price_dates_from'] ) : '';
$date_to = ( isset( $_POST['_sale_price_dates_to'] ) ) ? strtotime( $_POST['_sale_price_dates_to'] ) : '';
$now = gmdate( 'U' );
if ( ! empty( $date_to ) && empty( $date_from ) ) {
$date_from = $now;
}
update_post_meta( $post_id, '_sale_price_dates_from', $date_from );
update_post_meta( $post_id, '_sale_price_dates_to', $date_to );
// Update price if on sale
if ( ! empty( $sale_price ) && ( ( empty( $date_to ) && empty( $date_from ) ) || ( $date_from < $now && ( empty( $date_to ) || $date_to > $now ) ) ) ) {
$price = $sale_price;
} else {
$price = $subscription_price;
}
update_post_meta( $post_id, '_price', stripslashes( $price ) );
// Make sure trial period is within allowable range
$subscription_ranges = wcs_get_subscription_ranges();
$max_trial_length = count( $subscription_ranges[ $_POST['_subscription_trial_period'] ] ) - 1;
$_POST['_subscription_trial_length'] = absint( $_POST['_subscription_trial_length'] );
if ( $_POST['_subscription_trial_length'] > $max_trial_length ) {
$_POST['_subscription_trial_length'] = $max_trial_length;
}
update_post_meta( $post_id, '_subscription_trial_length', $_POST['_subscription_trial_length'] );
$_REQUEST['_subscription_sign_up_fee'] = wc_format_decimal( $_REQUEST['_subscription_sign_up_fee'] );
$_REQUEST['_subscription_one_time_shipping'] = isset( $_REQUEST['_subscription_one_time_shipping'] ) ? 'yes' : 'no';
$subscription_fields = array(
'_subscription_sign_up_fee',
'_subscription_period',
'_subscription_period_interval',
'_subscription_length',
'_subscription_trial_period',
'_subscription_limit',
'_subscription_one_time_shipping',
);
foreach ( $subscription_fields as $field_name ) {
if ( isset( $_REQUEST[ $field_name ] ) ) {
update_post_meta( $post_id, $field_name, stripslashes( $_REQUEST[ $field_name ] ) );
}
}
}
/**
* Save meta data for variable subscription product type when the "Edit Product" form is submitted.
*
* @param array Array of Product types & their labels, excluding the Subscription product type.
* @return array Array of Product types & their labels, including the Subscription product type.
* @since 2.0
*/
public static function save_variable_subscription_meta( $post_id ) {
if ( empty( $_POST['_wcsnonce'] ) || ! wp_verify_nonce( $_POST['_wcsnonce'], 'wcs_subscription_meta' ) || ! isset( $_POST['product-type'] ) || ! in_array( $_POST['product-type'], apply_filters( 'woocommerce_subscription_variable_product_types', array( 'variable-subscription' ) ) ) ) {
return;
}
if ( isset( $_REQUEST['_subscription_limit'] ) ) {
update_post_meta( $post_id, '_subscription_limit', stripslashes( $_REQUEST['_subscription_limit'] ) );
}
update_post_meta( $post_id, '_subscription_one_time_shipping', stripslashes( isset( $_REQUEST['_subscription_one_time_shipping'] ) ? 'yes' : 'no' ) );
}
/**
* Calculate and set a simple subscription's prices when edited via the bulk edit
*
* @param object $product An instance of a WC_Product_* object.
* @return null
* @since 1.3.9
*/
public static function bulk_edit_save_subscription_meta( $product ) {
if ( ! $product->is_type( 'subscription' ) ) {
return;
}
$price_changed = false;
$old_regular_price = $product->regular_price;
$old_sale_price = $product->sale_price;
if ( ! empty( $_REQUEST['change_regular_price'] ) ) {
$change_regular_price = absint( $_REQUEST['change_regular_price'] );
$regular_price = esc_attr( stripslashes( $_REQUEST['_regular_price'] ) );
switch ( $change_regular_price ) {
case 1 :
$new_price = $regular_price;
break;
case 2 :
if ( strstr( $regular_price, '%' ) ) {
$percent = str_replace( '%', '', $regular_price ) / 100;
$new_price = $old_regular_price + ( $old_regular_price * $percent );
} else {
$new_price = $old_regular_price + $regular_price;
}
break;
case 3 :
if ( strstr( $regular_price, '%' ) ) {
$percent = str_replace( '%', '', $regular_price ) / 100;
$new_price = $old_regular_price - ( $old_regular_price * $percent );
} else {
$new_price = $old_regular_price - $regular_price;
}
break;
}
if ( isset( $new_price ) && $new_price != $old_regular_price ) {
$price_changed = true;
update_post_meta( $product->id, '_regular_price', $new_price );
update_post_meta( $product->id, '_subscription_price', $new_price );
$product->regular_price = $new_price;
}
}
if ( ! empty( $_REQUEST['change_sale_price'] ) ) {
$change_sale_price = absint( $_REQUEST['change_sale_price'] );
$sale_price = esc_attr( stripslashes( $_REQUEST['_sale_price'] ) );
switch ( $change_sale_price ) {
case 1 :
$new_price = $sale_price;
break;
case 2 :
if ( strstr( $sale_price, '%' ) ) {
$percent = str_replace( '%', '', $sale_price ) / 100;
$new_price = $old_sale_price + ( $old_sale_price * $percent );
} else {
$new_price = $old_sale_price + $sale_price;
}
break;
case 3 :
if ( strstr( $sale_price, '%' ) ) {
$percent = str_replace( '%', '', $sale_price ) / 100;
$new_price = $old_sale_price - ( $old_sale_price * $percent );
} else {
$new_price = $old_sale_price - $sale_price;
}
break;
case 4 :
if ( strstr( $sale_price, '%' ) ) {
$percent = str_replace( '%', '', $sale_price ) / 100;
$new_price = $product->regular_price - ( $product->regular_price * $percent );
} else {
$new_price = $product->regular_price - $sale_price;
}
break;
}
if ( isset( $new_price ) && $new_price != $old_sale_price ) {
$price_changed = true;
update_post_meta( $product->id, '_sale_price', $new_price );
$product->sale_price = $new_price;
}
}
if ( $price_changed ) {
update_post_meta( $product->id, '_sale_price_dates_from', '' );
update_post_meta( $product->id, '_sale_price_dates_to', '' );
if ( $product->regular_price < $product->sale_price ) {
$product->sale_price = '';
update_post_meta( $product->id, '_sale_price', '' );
}
if ( $product->sale_price ) {
update_post_meta( $product->id, '_price', $product->sale_price );
} else {
update_post_meta( $product->id, '_price', $product->regular_price );
}
}
}
/**
* Save a variable subscription's details when the edit product page is submitted for a variable
* subscription product type (or the bulk edit product is saved).
*
* @param int $post_id ID of the parent WC_Product_Variable_Subscription
* @return null
* @since 1.3
*/
public static function process_product_meta_variable_subscription( $post_id ) {
if ( ! WC_Subscriptions_Product::is_subscription( $post_id ) || empty( $_POST['_wcsnonce_save_variations'] ) || ! wp_verify_nonce( $_POST['_wcsnonce_save_variations'], 'wcs_subscription_variations' ) ) {
return;
}
// Make sure WooCommerce calculates correct prices
$_POST['variable_regular_price'] = isset( $_POST['variable_subscription_price'] ) ? $_POST['variable_subscription_price'] : 0;
// Run WooCommerce core saving routine for WC < 2.4
if ( ! is_ajax() ) {
WC_Meta_Box_Product_Data::save_variations( $post_id, get_post( $post_id ) );
}
if ( ! isset( $_REQUEST['variable_post_id'] ) ) {
return;
}
$variable_post_ids = $_POST['variable_post_id'];
$max_loop = max( array_keys( $variable_post_ids ) );
// Save each variations details
for ( $i = 0; $i <= $max_loop; $i ++ ) {
if ( ! isset( $variable_post_ids[ $i ] ) ) {
continue;
}
$variation_id = absint( $variable_post_ids[ $i ] );
if ( isset( $_POST['variable_subscription_price'] ) && is_array( $_POST['variable_subscription_price'] ) ) {
$subscription_price = wc_format_decimal( $_POST['variable_subscription_price'][ $i ] );
update_post_meta( $variation_id, '_subscription_price', $subscription_price );
update_post_meta( $variation_id, '_regular_price', $subscription_price );
}
// Make sure trial period is within allowable range
$subscription_ranges = wcs_get_subscription_ranges();
$max_trial_length = count( $subscription_ranges[ $_POST['variable_subscription_trial_period'][ $i ] ] ) - 1;
$_POST['variable_subscription_trial_length'][ $i ] = absint( $_POST['variable_subscription_trial_length'][ $i ] );
if ( $_POST['variable_subscription_trial_length'][ $i ] > $max_trial_length ) {
$_POST['variable_subscription_trial_length'][ $i ] = $max_trial_length;
}
// Work around a WPML bug which means 'variable_subscription_trial_period' is not set when using "Edit Product" as the product translation interface
if ( $_POST['variable_subscription_trial_length'][ $i ] < 0 ) {
$_POST['variable_subscription_trial_length'][ $i ] = 0;
}
$subscription_fields = array(
'_subscription_sign_up_fee',
'_subscription_period',
'_subscription_period_interval',
'_subscription_length',
'_subscription_trial_period',
'_subscription_trial_length',
);
foreach ( $subscription_fields as $field_name ) {
if ( isset( $_POST[ 'variable' . $field_name ][ $i ] ) ) {
update_post_meta( $variation_id, $field_name, wc_clean( $_POST[ 'variable' . $field_name ][ $i ] ) );
}
}
}
// Now that all the variation's meta is saved, sync the min variation price
$variable_subscription = wc_get_product( $post_id );
$variable_subscription->variable_product_sync();
}
/**
* Set default values for subscription dropdown fields when bulk adding variations to fix issue #1342
*
* @param int $variation_id ID the post_id of the variation being added
* @return null
*/
public static function set_variation_meta_defaults_on_bulk_add( $variation_id ) {
if ( ! empty( $variation_id ) ) {
update_post_meta( $variation_id, '_subscription_period', 'month' );
update_post_meta( $variation_id, '_subscription_period_interval', '1' );
update_post_meta( $variation_id, '_subscription_length', '0' );
update_post_meta( $variation_id, '_subscription_trial_period', 'month' );
}
}
/**
* Adds all necessary admin styles.
*
* @param array Array of Product types & their labels, excluding the Subscription product type.
* @return array Array of Product types & their labels, including the Subscription product type.
* @since 1.0
*/
public static function enqueue_styles_scripts() {
global $post;
// Get admin screen id
$screen = get_current_screen();
$is_woocommerce_screen = ( in_array( $screen->id, array( 'product', 'edit-shop_order', 'shop_order', 'edit-shop_subscription', 'shop_subscription', 'users', 'woocommerce_page_wc-settings' ) ) ) ? true : false;
$is_activation_screen = ( get_transient( WC_Subscriptions::$activation_transient ) == true ) ? true : false;
if ( $is_woocommerce_screen ) {
$dependencies = array( 'jquery' );
$woocommerce_admin_script_handle = 'wc-admin-meta-boxes';
if ( $screen->id == 'product' ) {
$dependencies[] = $woocommerce_admin_script_handle;
$dependencies[] = 'wc-admin-product-meta-boxes';
$dependencies[] = 'wc-admin-variation-meta-boxes';
$script_params = array(
'productType' => WC_Subscriptions::$name,
'trialPeriodSingular' => wcs_get_available_time_periods(),
'trialPeriodPlurals' => wcs_get_available_time_periods( 'plural' ),
'subscriptionLengths' => wcs_get_subscription_ranges(),
'trialTooLongMessages' => self::get_trial_period_validation_message( 'separate' ),
'bulkEditPeriodMessage' => __( 'Enter the new period, either day, week, month or year:', 'woocommerce-subscriptions' ),
'bulkEditLengthMessage' => __( 'Enter a new length (e.g. 5):', 'woocommerce-subscriptions' ),
'bulkEditIntervalhMessage' => __( 'Enter a new interval as a single number (e.g. to charge every 2nd month, enter 2):', 'woocommerce-subscriptions' ),
);
} else if ( 'edit-shop_order' == $screen->id ) {
$script_params = array(
'bulkTrashWarning' => __( "You are about to trash one or more orders which contain a subscription.\n\nTrashing the orders will also trash the subscriptions purchased with these orders.", 'woocommerce-subscriptions' ),
);
} else if ( 'shop_order' == $screen->id ) {
$dependencies[] = $woocommerce_admin_script_handle;
$dependencies[] = 'wc-admin-order-meta-boxes';
if ( WC_Subscriptions::is_woocommerce_pre( '2.6' ) ) {
$dependencies[] = 'wc-admin-order-meta-boxes-modal';
}
$script_params = array(
'bulkTrashWarning' => __( 'Trashing this order will also trash the subscription purchased with the order.', 'woocommerce-subscriptions' ),
'changeMetaWarning' => __( "WARNING: Bad things are about to happen!\n\nThe payment gateway used to purchase this subscription does not support modifying a subscription's details.\n\nChanges to the billing period, recurring discount, recurring tax or recurring total may not be reflected in the amount charged by the payment gateway.", 'woocommerce-subscriptions' ),
'removeItemWarning' => __( 'You are deleting a subscription item. You will also need to manually cancel and trash the subscription on the Manage Subscriptions screen.', 'woocommerce-subscriptions' ),
'roundAtSubtotal' => esc_attr( get_option( 'woocommerce_tax_round_at_subtotal' ) ),
'EditOrderNonce' => wp_create_nonce( 'woocommerce-subscriptions' ),
'postId' => $post->ID,
);
} else if ( 'users' == $screen->id ) {
$script_params = array(
'deleteUserWarning' => __( "Warning: Deleting a user will also delete the user's subscriptions. The user's orders will remain but be reassigned to the 'Guest' user.\n\nDo you want to continue to delete this user and any associated subscriptions?", 'woocommerce-subscriptions' ),
);
}
$script_params['ajaxLoaderImage'] = WC()->plugin_url() . '/assets/images/ajax-loader.gif';
$script_params['ajaxUrl'] = admin_url( 'admin-ajax.php' );
$script_params['isWCPre24'] = var_export( WC_Subscriptions::is_woocommerce_pre( '2.4' ), true );
wp_enqueue_script( 'woocommerce_subscriptions_admin', plugin_dir_url( WC_Subscriptions::$plugin_file ) . 'assets/js/admin/admin.js', $dependencies, filemtime( plugin_dir_path( WC_Subscriptions::$plugin_file ) . 'assets/js/admin/admin.js' ) );
wp_localize_script( 'woocommerce_subscriptions_admin', 'WCSubscriptions', apply_filters( 'woocommerce_subscriptions_admin_script_parameters', $script_params ) );
// Maybe add the pointers for first timers
if ( isset( $_GET['subscription_pointers'] ) && self::show_user_pointers() ) {
$dependencies[] = 'wp-pointer';
$pointer_script_params = array(
// translators: placeholders are for HTML tags. They are 1$: "<h3>", 2$: "</h3>", 3$: "<p>", 4$: "<em>", 5$: "</em>", 6$: "<em>", 7$: "</em>", 8$: "</p>"
'typePointerContent' => sprintf( _x( '%1$sChoose Subscription%2$s%3$sThe WooCommerce Subscriptions extension adds two new subscription product types - %4$sSimple subscription%5$s and %6$sVariable subscription%7$s.%8$s', 'used in admin pointer script params in javascript as type pointer content', 'woocommerce-subscriptions' ), '<h3>', '</h3>', '<p>', '<em>', '</em>', '<em>', '</em>', '</p>' ),
// translators: placeholders are for HTML tags. They are 1$: "<h3>", 2$: "</h3>", 3$: "<p>", 4$: "</p>"
'pricePointerContent' => sprintf( _x( '%1$sSet a Price%2$s%3$sSubscription prices are a little different to other product prices. For a subscription, you can set a billing period, length, sign-up fee and free trial.%4$s', 'used in admin pointer script params in javascript as price pointer content', 'woocommerce-subscriptions' ), '<h3>', '</h3>', '<p>', '</p>' ),
);
wp_enqueue_script( 'woocommerce_subscriptions_admin_pointers', plugin_dir_url( WC_Subscriptions::$plugin_file ) . 'assets/js/admin/admin-pointers.js', $dependencies, WC_Subscriptions::$version );
wp_localize_script( 'woocommerce_subscriptions_admin_pointers', 'WCSPointers', apply_filters( 'woocommerce_subscriptions_admin_pointer_script_parameters', $pointer_script_params ) );
wp_enqueue_style( 'wp-pointer' );
}
}
// Maybe add the admin notice
if ( $is_activation_screen ) {
$woocommerce_plugin_dir_file = self::get_woocommerce_plugin_dir_file();
if ( ! empty( $woocommerce_plugin_dir_file ) ) {
wp_enqueue_style( 'woocommerce-activation', plugins_url( '/assets/css/activation.css', self::get_woocommerce_plugin_dir_file() ), array(), WC_Subscriptions::$version );
if ( ! isset( $_GET['page'] ) || 'wcs-about' != $_GET['page'] ) {
add_action( 'admin_notices', __CLASS__ . '::admin_installed_notice' );
}
}
delete_transient( WC_Subscriptions::$activation_transient );
}
if ( $is_woocommerce_screen || $is_activation_screen ) {
wp_enqueue_style( 'woocommerce_admin_styles', WC()->plugin_url() . '/assets/css/admin.css', array(), WC_Subscriptions::$version );
wp_enqueue_style( 'woocommerce_subscriptions_admin', plugin_dir_url( WC_Subscriptions::$plugin_file ) . 'assets/css/admin.css', array( 'woocommerce_admin_styles' ), WC_Subscriptions::$version );
}
}
/**
* Add the "Active Subscriber?" column to the User's admin table
*/
public static function add_user_columns( $columns ) {
if ( current_user_can( 'manage_woocommerce' ) ) {
// Move Active Subscriber before Orders for aesthetics
$last_column = array_slice( $columns, -1, 1, true );
array_pop( $columns );
$columns['woocommerce_active_subscriber'] = __( 'Active Subscriber?', 'woocommerce-subscriptions' );
$columns += $last_column;
}
return $columns;
}
/**
* Hooked to the users table to display a check mark if a given user has an active subscription.
*
* @param string $value The string to output in the column specified with $column_name
* @param string $column_name The string key for the current column in an admin table
* @param int $user_id The ID of the user to which this row relates
* @return string $value A check mark if the column is the active_subscriber column and the user has an active subscription.
* @since 1.0
*/
public static function user_column_values( $value, $column_name, $user_id ) {
if ( 'woocommerce_active_subscriber' == $column_name ) {
if ( wcs_user_has_subscription( $user_id, '', 'active' ) ) {
$value = '<div class="active-subscriber"></div>';
} else {
$value = '<div class="inactive-subscriber">-</div>';
}
}
return $value;
}
/**
* Outputs the Subscription Management admin page with a sortable @see WC_Subscriptions_List_Table used to
* display all the subscriptions that have been purchased.
*
* @uses WC_Subscriptions_List_Table
* @since 1.0
*/
public static function subscriptions_management_page() {
$subscriptions_table = self::get_subscriptions_list_table();
$subscriptions_table->prepare_items(); ?>
<div class="wrap">
<div id="icon-woocommerce" class="icon32-woocommerce-users icon32"><br/></div>
<h2><?php esc_html_e( 'Manage Subscriptions', 'woocommerce-subscriptions' ); ?></h2>
<?php $subscriptions_table->messages(); ?>
<?php $subscriptions_table->views(); ?>
<form id="subscriptions-search" action="" method="get"><?php // Don't send all the subscription meta across ?>
<?php $subscriptions_table->search_box( __( 'Search Subscriptions', 'woocommerce-subscriptions' ), 'subscription' ); ?>
<input type="hidden" name="page" value="subscriptions" />
<?php if ( isset( $_REQUEST['status'] ) ) { ?>
<input type="hidden" name="status" value="<?php echo esc_attr( $_REQUEST['status'] ); ?>" />
<?php } ?>
</form>
<form id="subscriptions-filter" action="" method="get">
<?php $subscriptions_table->display(); ?>
</form>
</div>
<?php
}
/**
* Outputs the screen options on the Subscription Management admin page.
*
* @since 1.3.1
*/
public static function add_manage_subscriptions_screen_options() {
add_screen_option( 'per_page', array(
'label' => __( 'Subscriptions', 'woocommerce-subscriptions' ),
'default' => 10,
'option' => self::$option_prefix . '_admin_per_page',
)
);
}
/**
* Sets the correct value for screen options on the Subscription Management admin page.
*
* @since 1.3.1
*/
public static function set_manage_subscriptions_screen_option( $status, $option, $value ) {
if ( self::$option_prefix . '_admin_per_page' == $option ) {
return $value;
}
return $status;
}
/**
* Returns the columns for the Manage Subscriptions table, specifically used for adding the
* show/hide column screen options.
*
* @since 1.3.1
*/
public static function get_subscription_table_columns( $columns ) {
$subscriptions_table = self::get_subscriptions_list_table();
return array_merge( $subscriptions_table->get_columns(), $columns );
}
/**
* Returns the columns for the Manage Subscriptions table, specifically used for adding the
* show/hide column screen options.
*
* @since 1.3.1
*/
public static function get_subscriptions_list_table() {
if ( ! isset( self::$subscriptions_list_table ) ) {
if ( ! class_exists( 'WC_Subscriptions_List_Table' ) ) {
require_once( 'class-wc-subscriptions-list-table.php' );
}
self::$subscriptions_list_table = new WC_Subscriptions_List_Table();
}
return self::$subscriptions_list_table;
}
/**
* Uses the WooCommerce options API to save settings via the @see woocommerce_update_options() function.
*
* @uses woocommerce_update_options()
* @uses self::get_settings()
* @since 1.0
*/
public static function update_subscription_settings() {
if ( empty( $_POST['_wcsnonce'] ) || ! wp_verify_nonce( $_POST['_wcsnonce'], 'wcs_subscription_settings' ) ) {
return;
}
// Make sure automatic payments are on when manual renewals are switched off
if ( ! isset( $_POST[ self::$option_prefix . '_accept_manual_renewals' ] ) && isset( $_POST[ self::$option_prefix . '_turn_off_automatic_payments' ] ) ) {
unset( $_POST[ self::$option_prefix . '_turn_off_automatic_payments' ] );
}
woocommerce_update_options( self::get_settings() );
}
/**
* Uses the WooCommerce admin fields API to output settings via the @see woocommerce_admin_fields() function.
*
* @uses woocommerce_admin_fields()
* @uses self::get_settings()
* @since 1.0
*/
public static function subscription_settings_page() {
woocommerce_admin_fields( self::get_settings() );
wp_nonce_field( 'wcs_subscription_settings', '_wcsnonce', false );
}
/**
* Add the Subscriptions settings tab to the WooCommerce settings tabs array.
*
* @param array $settings_tabs Array of WooCommerce setting tabs & their labels, excluding the Subscription tab.
* @return array $settings_tabs Array of WooCommerce setting tabs & their labels, including the Subscription tab.
* @since 1.0
*/
public static function add_subscription_settings_tab( $settings_tabs ) {
$settings_tabs[ self::$tab_name ] = __( 'Subscriptions', 'woocommerce-subscriptions' );
return $settings_tabs;
}
/**
* Sets default values for all the WooCommerce Subscription options. Called on plugin activation.
*
* @see WC_Subscriptions::activate_woocommerce_subscriptions
* @since 1.0
*/
public static function add_default_settings() {
foreach ( self::get_settings() as $setting ) {
if ( isset( $setting['default'] ) ) {
add_option( $setting['id'], $setting['default'] );
}
}
}
/**
* Get all the settings for the Subscriptions extension in the format required by the @see woocommerce_admin_fields() function.
*
* @return array Array of settings in the format required by the @see woocommerce_admin_fields() function.
* @since 1.0
*/
public static function get_settings() {
if ( ! function_exists( 'get_editable_roles' ) ) {
require_once( ABSPATH . 'wp-admin/includes/user.php' );
}
$roles = get_editable_roles();
foreach ( $roles as $role => $details ) {
$roles_options[ $role ] = translate_user_role( $details['name'] );
}
$available_gateways = array();
foreach ( WC()->payment_gateways->payment_gateways() as $gateway ) {
if ( $gateway->supports( 'subscriptions' ) ) {
$available_gateways[] = sprintf( '%s [<code>%s</code>]', $gateway->title, $gateway->id );
}
}
if ( count( $available_gateways ) == 0 ) {
// translators: $1-2: opening and closing tags of a link that takes to PayPal settings, $3-4: opening and closing tags of a link that takes to Woo marketplace / Stripe product page
$available_gateways_description = sprintf( __( 'No payment gateways capable of processing automatic subscription payments are enabled. Please enable the %1$sPayPal Standard%2$s gateway or get the %3$sfree Stripe extension%4$s if you want to process automatic payments.', 'woocommerce-subscriptions' ), '<strong><a href="' . admin_url( 'admin.php?page=wc-settings&tab=checkout§ion=wc_gateway_paypal' ) . '">', '</a></strong>', '<strong><a href="https://www.woothemes.com/products/stripe/">', '</a></strong>' );
} elseif ( count( $available_gateways ) == 1 ) {
// translators: placeholder is name of a gateway
$available_gateways_description = sprintf( __( 'The %s gateway can process automatic subscription payments.', 'woocommerce-subscriptions' ), '<strong>' . $available_gateways[0] . '</strong>' );
} elseif ( count( $available_gateways ) > 1 ) {
// translators: %1$s - a comma separated list of gateway names (e.g. "stripe, paypal, worldpay"), %2$s - one name of gateway (e.g. "authorize.net")
$available_gateways_description = sprintf( __( 'The %1$s & %2$s gateways can process automatic subscription payments.', 'woocommerce-subscriptions' ), '<strong>' . implode( '</strong>, <strong>', array_slice( $available_gateways, 0, count( $available_gateways ) - 1 ) ) . '</strong>', '<strong>' . array_pop( $available_gateways ) . '</strong>' );
}
return apply_filters( 'woocommerce_subscription_settings', array(
array(
'name' => __( 'Button Text', 'woocommerce-subscriptions' ),
'type' => 'title',
'desc' => '',
'id' => self::$option_prefix . '_button_text',
),
array(
'name' => __( 'Add to Cart Button Text', 'woocommerce-subscriptions' ),
'desc' => __( 'A product displays a button with the text "Add to Cart". By default, a subscription changes this to "Sign Up Now". You can customise the button text for subscriptions here.', 'woocommerce-subscriptions' ),
'tip' => '',
'id' => self::$option_prefix . '_add_to_cart_button_text',
'css' => 'min-width:150px;',
'default' => __( 'Sign Up Now', 'woocommerce-subscriptions' ),
'type' => 'text',
'desc_tip' => true,
),
array(
'name' => __( 'Place Order Button Text', 'woocommerce-subscriptions' ),
'desc' => __( 'Use this field to customise the text displayed on the checkout button when an order contains a subscription. Normally the checkout submission button displays "Place Order". When the cart contains a subscription, this is changed to "Sign Up Now".', 'woocommerce-subscriptions' ),
'tip' => '',
'id' => self::$option_prefix . '_order_button_text',
'css' => 'min-width:150px;',
'default' => __( 'Sign Up Now', 'woocommerce-subscriptions' ),
'type' => 'text',
'desc_tip' => true,
),
array( 'type' => 'sectionend', 'id' => self::$option_prefix . '_button_text' ),
array(
'name' => __( 'Roles', 'woocommerce-subscriptions' ),
'type' => 'title',
// translators: placeholders are <em> tags
'desc' => sprintf( __( 'Choose the default roles to assign to active and inactive subscribers. For record keeping purposes, a user account must be created for subscribers. Users with the %sadministrator%s role, such as yourself, will never be allocated these roles to prevent locking out administrators.', 'woocommerce-subscriptions' ), '<em>', '</em>' ),
'id' => self::$option_prefix . '_role_options',
),
array(
'name' => __( 'Subscriber Default Role', 'woocommerce-subscriptions' ),
'desc' => __( 'When a subscription is activated, either manually or after a successful purchase, new users will be assigned this role.', 'woocommerce-subscriptions' ),
'tip' => '',
'id' => self::$option_prefix . '_subscriber_role',
'css' => 'min-width:150px;',
'default' => 'subscriber',
'type' => 'select',
'options' => $roles_options,
'desc_tip' => true,
),
array(
'name' => __( 'Inactive Subscriber Role', 'woocommerce-subscriptions' ),
'desc' => __( 'If a subscriber\'s subscription is manually cancelled or expires, she will be assigned this role.', 'woocommerce-subscriptions' ),
'tip' => '',
'id' => self::$option_prefix . '_cancelled_role',
'css' => 'min-width:150px;',
'default' => 'customer',
'type' => 'select',
'options' => $roles_options,
'desc_tip' => true,
),
array( 'type' => 'sectionend', 'id' => self::$option_prefix . '_role_options' ),
array(
'name' => _x( 'Renewals', 'option section heading', 'woocommerce-subscriptions' ),
'type' => 'title',
'desc' => '',
'id' => self::$option_prefix . '_renewal_options',
),
array(
'name' => __( 'Manual Renewal Payments', 'woocommerce-subscriptions' ),
'desc' => __( 'Accept Manual Renewals', 'woocommerce-subscriptions' ),
'id' => self::$option_prefix . '_accept_manual_renewals',
'default' => 'no',
'type' => 'checkbox',
// translators: placeholders are opening and closing link tags
'desc_tip' => sprintf( __( 'With manual renewals, a customer\'s subscription is put on-hold until they login and pay to renew it. %sLearn more%s.', 'woocommerce-subscriptions' ), '<a href="http://docs.woothemes.com/document/subscriptions/store-manager-guide/#accept-manual-renewals">', '</a>' ),
'checkboxgroup' => 'start',
'show_if_checked' => 'option',
),
array(
'desc' => __( 'Turn off Automatic Payments', 'woocommerce-subscriptions' ),
'id' => self::$option_prefix . '_turn_off_automatic_payments',
'default' => 'no',
'type' => 'checkbox',
// translators: placeholders are opening and closing link tags
'desc_tip' => sprintf( __( 'If you never want a customer to be automatically charged for a subscription renewal payment, you can turn off automatic payments completely. %sLearn more%s.', 'woocommerce-subscriptions' ), '<a href="http://docs.woothemes.com/document/subscriptions/store-manager-guide/#turn-off-automatic-payments">', '</a>' ),
'checkboxgroup' => 'end',
'show_if_checked' => 'yes',
),
array( 'type' => 'sectionend', 'id' => self::$option_prefix . '_renewal_options' ),
array(
'name' => _x( 'Miscellaneous', 'options section heading', 'woocommerce-subscriptions' ),
'type' => 'title',
'desc' => '',
'id' => self::$option_prefix . '_miscellaneous',
),
array(
'name' => __( 'Customer Suspensions', 'woocommerce-subscriptions' ),
'desc' => _x( 'suspensions per billing period.', 'there\'s a number immediately in front of this text', 'woocommerce-subscriptions' ),
'id' => self::$option_prefix . '_max_customer_suspensions',
'css' => 'min-width:50px;',
'default' => 0,
'type' => 'select',
'options' => apply_filters( 'woocommerce_subscriptions_max_customer_suspension_range', array_merge( range( 0, 12 ), array( 'unlimited' => 'Unlimited' ) ) ),
'desc_tip' => __( 'Set a maximum number of times a customer can suspend their account for each billing period. For example, for a value of 3 and a subscription billed yearly, if the customer has suspended their account 3 times, they will not be presented with the option to suspend their account until the next year. Store managers will always be able able to suspend an active subscription. Set this to 0 to turn off the customer suspension feature completely.', 'woocommerce-subscriptions' ),
),
array(
'name' => __( 'Mixed Checkout', 'woocommerce-subscriptions' ),
'desc' => __( 'Allow subscriptions and products to be purchased simultaneously.', 'woocommerce-subscriptions' ),
'id' => self::$option_prefix . '_multiple_purchase',
'default' => 'no',
'type' => 'checkbox',
'desc_tip' => __( 'Allow subscriptions and products to be purchased in a single transaction.', 'woocommerce-subscriptions' ),
),
array(
'name' => __( 'Drip Downloadable Content', 'woocommerce-subscriptions' ),
'desc' => __( 'Enable dripping for downloadable content on subscription products.', 'woocommerce-subscriptions' ),
'id' => self::$option_prefix . '_drip_downloadable_content_on_renewal',
'default' => 'no',
'type' => 'checkbox',
'desc_tip' => sprintf( __( 'Enabling this grants access to new downloadable files added to a product only after the next renewal is processed.%sBy default, access to new downloadable files added to a product is granted immediately to any customer that has an active subscription with that product.', 'woocommerce-subscriptions' ), '<br />' ),
),
array( 'type' => 'sectionend', 'id' => self::$option_prefix . '_miscellaneous' ),
array(
'name' => __( 'Payment Gateways', 'woocommerce-subscriptions' ),
'desc' => $available_gateways_description,
'id' => self::$option_prefix . '_payment_gateways_available',
'type' => 'informational',
),
array(
// translators: placeholders are opening and closing link tags
'desc' => sprintf( __( 'Other payment gateways can be used to process %smanual subscription renewal payments%s only.', 'woocommerce-subscriptions' ), '<a href="http://docs.woothemes.com/document/subscriptions/renewal-process/">', '</a>' ),
'id' => self::$option_prefix . '_payment_gateways_additional',
'type' => 'informational',
),
array(
// translators: $1-$2: opening and closing tags. Link to documents->payment gateways, 3$-4$: opening and closing tags. Link to woothemes extensions shop page
'desc' => sprintf( __( 'Find new gateways that %1$ssupport automatic subscription payments%2$s in the official %3$sWooCommerce Marketplace%4$s.', 'woocommerce-subscriptions' ), '<a href="' . esc_url( 'http://docs.woothemes.com/document/subscriptions/payment-gateways/' ) . '">', '</a>', '<a href="' . esc_url( 'http://www.woothemes.com/product-category/woocommerce-extensions/' ) . '">', '</a>' ),
'id' => self::$option_prefix . '_payment_gateways_additional',
'type' => 'informational',
),
) );
}
/**
* Displays instructional information for a WooCommerce setting.
*
* @since 1.0
*/
public static function add_informational_admin_field( $field_details ) {
if ( isset( $field_details['name'] ) && $field_details['name'] ) {
echo '<h3>' . esc_html( $field_details['name'] ) . '</h3>';
}
if ( isset( $field_details['desc'] ) && $field_details['desc'] ) {
echo wp_kses_post( wpautop( wptexturize( $field_details['desc'] ) ) );
}
}
/**
* Outputs a welcome message. Called when the Subscriptions extension is activated.
*
* @since 1.0
*/
public static function admin_installed_notice() {
?>
<div id="message" class="updated woocommerce-message wc-connect woocommerce-subscriptions-activated">
<div class="squeezer">
<h4>
<?php
// translators: $1-$2: opening and closing <strong> tags, $3-$4: opening and closing <em> tags
echo wp_kses( sprintf( __( '%1$sWooCommerce Subscriptions Installed%2$s – %3$sYou\'re ready to start selling subscriptions!%4$s', 'woocommerce-subscriptions' ), '<strong>', '</strong>', '<em>', '</em>' ), array( 'strong' => true, 'em' => true ) );
?>
</h4>
<p class="submit">
<a href="<?php echo esc_url( self::add_subscription_url() ); ?>" class="button button-primary"><?php esc_html_e( 'Add a Subscription Product', 'woocommerce-subscriptions' ); ?></a>
<a href="<?php echo esc_url( self::settings_tab_url() ); ?>" class="docs button button-primary"><?php esc_html_e( 'Settings', 'woocommerce-subscriptions' ); ?></a>
<a href="https://twitter.com/share" class="twitter-share-button" data-url="http://www.woothemes.com/products/woocommerce-subscriptions/" data-text="Woot! I can sell subscriptions with #WooCommerce" data-via="WooThemes" data-size="large">Tweet</a>
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
</p>
</div>
</div>
<?php
}
/**
* Checks whether a user should be shown pointers or not, based on whether a user has previously dismissed pointers.
*
* @since 1.0
*/
public static function show_user_pointers() {
// Get dismissed pointers
$dismissed = explode( ',', (string) get_user_meta( get_current_user_id(), 'dismissed_wp_pointers', true ) );
// Pointer has been dismissed
if ( in_array( 'wcs_pointer', $dismissed ) ) {
return false;
} else {
return true;
}
}
/**
* Returns a URL for adding/editing a subscription, which special parameters to define whether pointers should be shown.
*
* The 'select_subscription' flag is picked up by JavaScript to set the value of the product type to "Subscription".
*
* @since 1.0
*/
public static function add_subscription_url( $show_pointers = true ) {
$add_subscription_url = admin_url( 'post-new.php?post_type=product&select_subscription=true' );
if ( true == $show_pointers ) {
$add_subscription_url = add_query_arg( 'subscription_pointers', 'true', $add_subscription_url );
}
return $add_subscription_url;
}
/**
* Searches through the list of active plugins to find WooCommerce. Just in case
* WooCommerce resides in a folder other than /woocommerce/
*
* @since 1.0
*/
public static function get_woocommerce_plugin_dir_file() {
$woocommerce_plugin_file = '';
foreach ( get_option( 'active_plugins', array() ) as $plugin ) {
if ( substr( $plugin, strlen( '/woocommerce.php' ) * -1 ) === '/woocommerce.php' ) {
$woocommerce_plugin_file = $plugin;
break;
}
}
return $woocommerce_plugin_file;
}
/**
* Filter the "Orders" list to show only orders associated with a specific subscription.
*
* @param string $where
* @param string $request
* @return string
* @since 2.0
*/
public static function filter_orders( $where ) {
global $typenow, $wpdb;
if ( is_admin() && 'shop_order' == $typenow ) {
$related_orders = array();
if ( isset( $_GET['_subscription_related_orders'] ) && $_GET['_subscription_related_orders'] > 0 ) {
$subscription_id = absint( $_GET['_subscription_related_orders'] );
$subscription = wcs_get_subscription( $subscription_id );
if ( ! wcs_is_subscription( $subscription ) ) {
// translators: placeholder is a number
wcs_add_admin_notice( sprintf( __( 'We can\'t find a subscription with ID #%d. Perhaps it was deleted?', 'woocommerce-subscriptions' ), $subscription_id ), 'error' );
$where .= " AND {$wpdb->posts}.ID = 0";
} else {
self::$found_related_orders = true;
$where .= sprintf( " AND {$wpdb->posts}.ID IN (%s)", implode( ',', array_map( 'absint', array_unique( $subscription->get_related_orders( 'ids' ) ) ) ) );
}
}
}
return $where;
}
/**
* Display a notice indicating that the "Orders" list is filtered.
* @see self::filter_orders()
*/
public static function display_renewal_filter_notice() {
global $wp_version;
$query_arg = '_subscription_related_orders';
if ( isset( $_GET[ $query_arg ] ) && $_GET[ $query_arg ] > 0 && true === self::$found_related_orders ) {
$initial_order = new WC_Order( absint( $_GET[ $query_arg ] ) );
if ( version_compare( $wp_version, '4.2', '<' ) ) {
echo '<div class="updated"><p>';
printf(
'<a href="%1$s" class="close-subscriptions-search">×</a>',
esc_url( remove_query_arg( $query_arg ) )
);
// translators: placeholders are opening link tag, ID of sub, and closing link tag
printf( esc_html__( 'Showing orders for %sSubscription %s%s', 'woocommerce-subscriptions' ), '<a href="' . esc_url( get_edit_post_link( absint( $_GET[ $query_arg ] ) ) ) . '">', esc_html( $initial_order->get_order_number() ), '</a>' );
echo '</p>';
} else {
echo '<div class="updated dismiss-subscriptions-search"><p>';
// translators: placeholders are opening link tag, ID of sub, and closing link tag
printf( esc_html__( 'Showing orders for %sSubscription %s%s', 'woocommerce-subscriptions' ), '<a href="' . esc_url( get_edit_post_link( absint( $_GET[ $query_arg ] ) ) ) . '">', esc_html( $initial_order->get_order_number() ), '</a>' );
echo '</p>';
printf(
'<a href="%1$s" class="notice-dismiss"><span class="screen-reader-text">Dismiss this notice.</span></a>',
esc_url( remove_query_arg( $query_arg ) )
);
}
echo '</div>';
}
}
/**
* Returns either a string or array of strings describing the allowable trial period range
* for a subscription.
*
* @since 1.0
*/
public static function get_trial_period_validation_message( $form = 'combined' ) {
$subscription_ranges = wcs_get_subscription_ranges();
if ( 'combined' == $form ) {
// translators: number of 1$: days, 2$: weeks, 3$: months, 4$: years
$error_message = sprintf( __( 'The trial period can not exceed: %1s, %2s, %3s or %4s.', 'woocommerce-subscriptions' ), array_pop( $subscription_ranges['day'] ), array_pop( $subscription_ranges['week'] ), array_pop( $subscription_ranges['month'] ), array_pop( $subscription_ranges['year'] ) );
} else {
$error_message = array();
foreach ( wcs_get_available_time_periods() as $period => $string ) {
// translators: placeholder is a time period (e.g. "4 weeks")
$error_message[ $period ] = sprintf( __( 'The trial period can not exceed %s.', 'woocommerce-subscriptions' ), array_pop( $subscription_ranges[ $period ] ) );
}
}
return apply_filters( 'woocommerce_subscriptions_trial_period_validation_message', $error_message );
}
/**
* Callback for the [subscriptions] shortcode that displays subscription names for a particular user.
*
* @param array $attributes Shortcode attributes.
* @return string
*/
public static function do_subscriptions_shortcode( $attributes ) {
$attributes = wp_parse_args(
$attributes,
array(
'user_id' => 0,
'status' => 'active',
)
);
$subscriptions = wcs_get_users_subscriptions( $attributes['user_id'] );
if ( empty( $subscriptions ) ) {
return '<ul class="user-subscriptions no-user-subscriptions">
<li>No subscriptions found.</li>
</ul>';
}
$list = '<ul class="user-subscriptions">';
foreach ( $subscriptions as $subscription ) {
if ( 'all' == $attributes['status'] || $subscription->has_status( $attributes['status'] ) ) {
$list .= sprintf( '<li><a href="%s">Subscription %s</a></li>', $subscription->get_view_order_url(), $subscription->get_order_number() );
}
}
$list .= '</ul>';
return $list;
}
/**
* Adds Subscriptions specific details to the WooCommerce System Status report.
*
* @param array $attributes Shortcode attributes.
* @return array
*/
public static function add_system_status_items( $debug_data ) {
$is_wcs_debug = defined( 'WCS_DEBUG' ) ? WCS_DEBUG : false;
$debug_data['wcs_debug'] = array(
'name' => _x( 'WCS_DEBUG', 'label that indicates whether debugging is turned on for the plugin', 'woocommerce-subscriptions' ),
'note' => ( $is_wcs_debug ) ? __( 'Yes', 'woocommerce-subscriptions' ) : __( 'No', 'woocommerce-subscriptions' ),
'success' => $is_wcs_debug ? 0 : 1,
);
$debug_data['wcs_staging'] = array(
'name' => _x( 'Subscriptions Mode', 'Live or Staging, Label on WooCommerce -> System Status page', 'woocommerce-subscriptions' ),
'note' => '<strong>' . ( ( WC_Subscriptions::is_duplicate_site() ) ? _x( 'Staging', 'refers to staging site', 'woocommerce-subscriptions' ) : _x( 'Live', 'refers to live site', 'woocommerce-subscriptions' ) ) . '</strong>',
'success' => ( WC_Subscriptions::is_duplicate_site() ) ? 0 : 1,
);
return $debug_data;
}
/**
* A WooCommerce version aware function for getting the Subscriptions admin settings
* tab URL.
*
* @since 1.4.5
* @return string
*/
public static function settings_tab_url() {
$settings_tab_url = admin_url( 'admin.php?page=wc-settings&tab=subscriptions' );
return apply_filters( 'woocommerce_subscriptions_settings_tab_url', $settings_tab_url );
}
/**
* Add a column to the Payment Gateway table to show whether the gateway supports automated renewals.
*
* @since 1.5
* @return string
*/
public static function payment_gateways_rewewal_column( $header ) {
$header_new = array_slice( $header, 0, count( $header ) - 1, true ) +
array( 'renewals' => __( 'Automatic Recurring Payments', 'woocommerce-subscriptions' ) ) + // Ideally, we could add a link to the docs here, but the title is passed through esc_html()
array_slice( $header, count( $header ) - 1, count( $header ) - ( count( $header ) - 1 ), true );
return $header_new;
}
/**
* Check whether the payment gateway passed in supports automated renewals or not.
* Automatically flag support for Paypal since it is included with subscriptions.
* Display in the Payment Gateway column.
*
* @since 1.5
*/
public static function payment_gateways_rewewal_support( $gateway ) {
echo '<td class="renewals">';
if ( ( is_array( $gateway->supports ) && in_array( 'subscriptions', $gateway->supports ) ) || $gateway->id == 'paypal' ) {
$status_html = '<span class="status-enabled tips" data-tip="' . esc_attr__( 'Supports automatic renewal payments with the WooCommerce Subscriptions extension.', 'woocommerce-subscriptions' ) . '">' . esc_html__( 'Yes', 'woocommerce-subscriptions' ) . '</span>';
} else {
$status_html = '-';
}
$allowed_html = wp_kses_allowed_html( 'post' );
$allowed_html['span']['data-tip'] = true;
/**
* Automatic Renewal Payments Support Status HTML Filter.
*
* @since 2.0
* @param string $status_html
* @param \WC_Payment_Gateway $gateway
*/
echo wp_kses( apply_filters( 'woocommerce_payment_gateways_renewal_support_status_html', $status_html, $gateway ), $allowed_html );
echo '</td>';
}
/**
* Do not display formatted order total on the Edit Order administration screen
*
* @since 1.5.17
*/
public static function maybe_remove_formatted_order_total_filter( $formatted_total, $order ) {
// Check if we're on the Edit Order screen - get_current_screen() only exists on admin pages so order of operations matters here
if ( is_admin() && function_exists( 'get_current_screen' ) ) {
$screen = get_current_screen();
if ( is_object( $screen ) && 'shop_order' == $screen->id ) {
remove_filter( 'woocommerce_get_formatted_order_total', 'WC_Subscriptions_Order::get_formatted_order_total', 10, 2 );
}
}
return $formatted_total;
}
/**
* Deprecated due to new meta boxes required for WC 2.2.
*
* @deprecated 1.5.10
*/
public static function add_related_orders_meta_box() {
_deprecated_function( __METHOD__, '1.5.10', __CLASS__ . '::add_meta_boxes()' );
self::add_meta_boxes();
}
/**
* Outputs the contents of the "Renewal Orders" meta box.
*
* @param object $post Current post data.
*/
public static function related_orders_meta_box( $post ) {
_deprecated_function( __METHOD__, '2.0', 'WCS_Meta_Box_Related_Orders::output()' );
WCS_Meta_Box_Related_Orders::output();
}
/**
* Add users with subscriptions to the "Customers" report in WooCommerce -> Reports.
*
* @param WP_User_Query $user_query
*/
public static function add_subscribers_to_customers( $user_query ) {
_deprecated_function( __METHOD__, '2.0' );
}
/**
* Set a translation safe screen ID for Subcsription
*
* @since 1.3.3
*/
public static function set_admin_screen_id() {
_deprecated_function( __METHOD__, '2.0' );
}
/**
* Once we have set a correct admin page screen ID, we can use it for adding the Manage Subscriptions table's columns.
*
* @since 1.3.3
*/
public static function add_subscriptions_table_column_filter() {
_deprecated_function( __METHOD__, '2.0' );
}
/**
* Removes anything that's not a digit or a dot from a string. Sadly it assumes that the decimal separator is a dot.
* That however can be changed in WooCommerce settings, surfacing bugs such as 9,90 becoming 990, a hundred fold
* increase. Use wc_format_decimal instead.
*
* Left in for backward compatibility reasons.
*
* @deprecated 1.5.24
*/
private static function clean_number( $number ) {
_deprecated_function( __METHOD__, '1.5.23', 'wc_format_decimal()' );
$number = preg_replace( '/[^0-9\.]/', '', $number );
return $number;
}
/**
* Filter the "Orders" list to show only renewal orders associated with a specific parent order.
*
* @param array $request
* @return array
*/
public static function filter_orders_by_renewal_parent( $request ) {
_deprecated_function( __METHOD__, '2.0' );
return $request;
}
/**
* Registers the "Renewal Orders" meta box for the "Edit Order" page.
* @deprecated 2.0
*/
public static function add_meta_boxes() {
_deprecated_function( __METHOD__, '2.0', 'WCS_Admin_Meta_Boxes::add_meta_boxes()' );
}
/**
* Output the metabox
*/
public static function recurring_totals_meta_box( $post ) {
_deprecated_function( __METHOD__, '2.0' );
}
}
WC_Subscriptions_Admin::init();