forked from pronamic/woocommerce-subscriptions
-
Notifications
You must be signed in to change notification settings - Fork 0
/
woocommerce-subscriptions.php
1272 lines (1002 loc) · 49.8 KB
/
woocommerce-subscriptions.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
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
<?php
/**
* Plugin Name: WooCommerce Subscriptions
* Plugin URI: http://www.woocommerce.com/products/woocommerce-subscriptions/
* Description: Sell products and services with recurring payments in your WooCommerce Store.
* Author: Prospress Inc.
* Author URI: http://prospress.com/
* Version: 2.2.13
*
* Woo: 27147:6115e6d7e297b623a169fdcf5728b224
*
* Copyright 2017 Prospress, Inc. (email : freedoms@prospress.com)
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @package WooCommerce Subscriptions
* @author Prospress Inc.
* @since 1.0
*/
/**
* Required functions
*/
if ( ! function_exists( 'woothemes_queue_update' ) || ! function_exists( 'is_woocommerce_active' ) ) {
require_once( 'woo-includes/woo-functions.php' );
}
/**
* Plugin updates
*/
woothemes_queue_update( plugin_basename( __FILE__ ), '6115e6d7e297b623a169fdcf5728b224', '27147' );
/**
* Check if WooCommerce is active and at the required minimum version, and if it isn't, disable Subscriptions.
*
* @since 1.0
*/
if ( ! is_woocommerce_active() || version_compare( get_option( 'woocommerce_db_version' ), '2.5', '<' ) ) {
add_action( 'admin_notices', 'WC_Subscriptions::woocommerce_inactive_notice' );
return;
}
require_once( 'wcs-functions.php' );
require_once( 'includes/class-wc-subscriptions-coupon.php' );
require_once( 'includes/class-wc-subscriptions-product.php' );
require_once( 'includes/admin/class-wc-subscriptions-admin.php' );
require_once( 'includes/class-wc-subscriptions-manager.php' );
require_once( 'includes/class-wc-subscriptions-cart.php' );
require_once( 'includes/class-wc-subscriptions-order.php' );
require_once( 'includes/class-wc-subscriptions-renewal-order.php' );
require_once( 'includes/class-wc-subscriptions-checkout.php' );
require_once( 'includes/class-wc-subscriptions-email.php' );
require_once( 'includes/class-wc-subscriptions-addresses.php' );
require_once( 'includes/class-wc-subscriptions-change-payment-gateway.php' );
require_once( 'includes/gateways/class-wc-subscriptions-payment-gateways.php' );
require_once( 'includes/gateways/paypal/class-wcs-paypal.php' );
require_once( 'includes/class-wc-subscriptions-switcher.php' );
require_once( 'includes/class-wc-subscriptions-synchroniser.php' );
require_once( 'includes/upgrades/class-wc-subscriptions-upgrader.php' );
require_once( 'includes/upgrades/class-wcs-upgrade-logger.php' );
require_once( 'includes/libraries/tlc-transients/tlc-transients.php' );
require_once( 'includes/libraries/action-scheduler/action-scheduler.php' );
require_once( 'includes/abstracts/abstract-wcs-scheduler.php' );
require_once( 'includes/class-wcs-action-scheduler.php' );
require_once( 'includes/abstracts/abstract-wcs-cache-manager.php' );
require_once( 'includes/class-wcs-cached-data-manager.php' );
require_once( 'includes/class-wcs-cart-renewal.php' );
require_once( 'includes/class-wcs-cart-resubscribe.php' );
require_once( 'includes/class-wcs-cart-initial-payment.php' );
require_once( 'includes/class-wcs-download-handler.php' );
require_once( 'includes/class-wcs-retry-manager.php' );
require_once( 'includes/class-wcs-cart-switch.php' );
require_once( 'includes/class-wcs-limiter.php' );
require_once( 'includes/legacy/class-wcs-array-property-post-meta-black-magic.php' );
/**
* The main subscriptions class.
*
* @since 1.0
*/
class WC_Subscriptions {
public static $name = 'subscription';
public static $activation_transient = 'woocommerce_subscriptions_activated';
public static $plugin_file = __FILE__;
public static $version = '2.2.13';
private static $total_subscription_count = null;
private static $scheduler;
/** @var WCS_Cache_Manager */
public static $cache;
/**
* Set up the class, including it's hooks & filters, when the file is loaded.
*
* @since 1.0
**/
public static function init() {
// Register our custom subscription order type after WC_Post_types::register_post_types()
add_action( 'init', __CLASS__ . '::register_order_types', 6 );
add_filter( 'woocommerce_data_stores', __CLASS__ . '::add_data_stores', 10, 1 );
// Register our custom subscription order statuses before WC_Post_types::register_post_status()
add_action( 'init', __CLASS__ . '::register_post_status', 9 );
add_action( 'init', __CLASS__ . '::maybe_activate_woocommerce_subscriptions' );
register_deactivation_hook( __FILE__, __CLASS__ . '::deactivate_woocommerce_subscriptions' );
// Override the WC default "Add to Cart" text to "Sign Up Now" (in various places/templates)
add_filter( 'woocommerce_order_button_text', __CLASS__ . '::order_button_text' );
add_action( 'woocommerce_subscription_add_to_cart', __CLASS__ . '::subscription_add_to_cart', 30 );
add_action( 'woocommerce_variable-subscription_add_to_cart', __CLASS__ . '::variable_subscription_add_to_cart', 30 );
add_action( 'wcopc_subscription_add_to_cart', __CLASS__ . '::wcopc_subscription_add_to_cart' ); // One Page Checkout compatibility
// Ensure a subscription is never in the cart with products
add_filter( 'woocommerce_add_to_cart_validation', __CLASS__ . '::maybe_empty_cart', 10, 4 );
// Enqueue front-end styles, run after Storefront because it sets the styles to be empty
add_filter( 'woocommerce_enqueue_styles', __CLASS__ . '::enqueue_styles', 100, 1 );
// Load translation files
add_action( 'init', __CLASS__ . '::load_plugin_textdomain', 3 );
// Load dependent files
add_action( 'plugins_loaded', __CLASS__ . '::load_dependant_classes' );
// Attach hooks which depend on WooCommerce constants
add_action( 'plugins_loaded', __CLASS__ . '::attach_dependant_hooks' );
// Staging site or site migration notice
add_action( 'admin_notices', __CLASS__ . '::woocommerce_site_change_notice' );
// Add the "Settings | Documentation" links on the Plugins administration screen
add_filter( 'plugin_action_links_' . plugin_basename( __FILE__ ), __CLASS__ . '::action_links' );
add_filter( 'action_scheduler_queue_runner_batch_size', __CLASS__ . '::action_scheduler_multisite_batch_size' );
add_action( 'in_plugin_update_message-' . plugin_basename( __FILE__ ), __CLASS__ . '::update_notice', 10, 2 );
self::$cache = WCS_Cache_Manager::get_instance();
$scheduler_class = apply_filters( 'woocommerce_subscriptions_scheduler', 'WCS_Action_Scheduler' );
self::$scheduler = new $scheduler_class();
}
/**
* Register data stores for WooCommerce 3.0+
*
* @since 2.2.0
*/
public static function add_data_stores( $data_stores ) {
$data_stores['subscription'] = 'WCS_Subscription_Data_Store_CPT';
// Use WC core data stores for our products
$data_stores['product-variable-subscription'] = 'WC_Product_Variable_Data_Store_CPT';
$data_stores['product-subscription_variation'] = 'WC_Product_Variation_Data_Store_CPT';
$data_stores['order-item-line_item_pending_switch'] = 'WC_Order_Item_Product_Data_Store';
return $data_stores;
}
/**
* Register core post types
*
* @since 2.0
*/
public static function register_order_types() {
wc_register_order_type(
'shop_subscription',
apply_filters( 'woocommerce_register_post_type_subscription',
array(
// register_post_type() params
'labels' => array(
'name' => __( 'Subscriptions', 'woocommerce-subscriptions' ),
'singular_name' => __( 'Subscription', 'woocommerce-subscriptions' ),
'add_new' => _x( 'Add Subscription', 'custom post type setting', 'woocommerce-subscriptions' ),
'add_new_item' => _x( 'Add New Subscription', 'custom post type setting', 'woocommerce-subscriptions' ),
'edit' => _x( 'Edit', 'custom post type setting', 'woocommerce-subscriptions' ),
'edit_item' => _x( 'Edit Subscription', 'custom post type setting', 'woocommerce-subscriptions' ),
'new_item' => _x( 'New Subscription', 'custom post type setting', 'woocommerce-subscriptions' ),
'view' => _x( 'View Subscription', 'custom post type setting', 'woocommerce-subscriptions' ),
'view_item' => _x( 'View Subscription', 'custom post type setting', 'woocommerce-subscriptions' ),
'search_items' => __( 'Search Subscriptions', 'woocommerce-subscriptions' ),
'not_found' => self::get_not_found_text(),
'not_found_in_trash' => _x( 'No Subscriptions found in trash', 'custom post type setting', 'woocommerce-subscriptions' ),
'parent' => _x( 'Parent Subscriptions', 'custom post type setting', 'woocommerce-subscriptions' ),
'menu_name' => __( 'Subscriptions', 'woocommerce-subscriptions' ),
),
'description' => __( 'This is where subscriptions are stored.', 'woocommerce-subscriptions' ),
'public' => false,
'show_ui' => true,
'capability_type' => 'shop_order',
'map_meta_cap' => true,
'publicly_queryable' => false,
'exclude_from_search' => true,
'show_in_menu' => current_user_can( 'manage_woocommerce' ) ? 'woocommerce' : true,
'hierarchical' => false,
'show_in_nav_menus' => false,
'rewrite' => false,
'query_var' => false,
'supports' => array( 'title', 'comments', 'custom-fields' ),
'has_archive' => false,
// wc_register_order_type() params
'exclude_from_orders_screen' => true,
'add_order_meta_boxes' => true,
'exclude_from_order_count' => true,
'exclude_from_order_views' => true,
'exclude_from_order_webhooks' => true,
'exclude_from_order_reports' => true,
'exclude_from_order_sales_reports' => true,
'class_name' => self::is_woocommerce_pre( '3.0' ) ? 'WC_Subscription_Legacy' : 'WC_Subscription',
)
)
);
}
/**
* Method that returns the not found text. If the user has created at least one subscription, the standard message
* will appear. If that's empty, the long, explanatory one will appear in the table.
*
* Filters:
* - woocommerce_subscriptions_not_empty: gets passed the boolean option value. 'true' means the subscriptions
* list is not empty, the user is familiar with how it works, and standard message appears.
* - woocommerce_subscriptions_not_found_label: gets the original message for other plugins to modify, in case
* they want to add more links, or modify any of the messages.
* @since 2.0
*
* @return string what appears in the list table of the subscriptions
*/
private static function get_not_found_text() {
$subscriptions_exist = self::$cache->cache_and_get( 'wcs_do_subscriptions_exist', 'wcs_do_subscriptions_exist' );
if ( true === apply_filters( 'woocommerce_subscriptions_not_empty', $subscriptions_exist ) ) {
$not_found_text = __( 'No Subscriptions found', 'woocommerce-subscriptions' );
} else {
$not_found_text = '<p>' . __( 'Subscriptions will appear here for you to view and manage once purchased by a customer.', 'woocommerce-subscriptions' ) . '</p>';
// translators: placeholders are opening and closing link tags
$not_found_text .= '<p>' . sprintf( __( '%sLearn more about managing subscriptions »%s', 'woocommerce-subscriptions' ), '<a href="http://docs.woocommerce.com/document/subscriptions/store-manager-guide/#section-3" target="_blank">', '</a>' ) . '</p>';
// translators: placeholders are opening and closing link tags
$not_found_text .= '<p>' . sprintf( __( '%sAdd a subscription product »%s', 'woocommerce-subscriptions' ), '<a href="' . esc_url( WC_Subscriptions_Admin::add_subscription_url() ) . '">', '</a>' ) . '</p>';
}
return apply_filters( 'woocommerce_subscriptions_not_found_label', $not_found_text );
}
/**
* Register our custom post statuses, used for order/subscription status
*/
public static function register_post_status() {
$subscription_statuses = wcs_get_subscription_statuses();
$registered_statuses = apply_filters( 'woocommerce_subscriptions_registered_statuses', array(
'wc-active' => _nx_noop( 'Active <span class="count">(%s)</span>', 'Active <span class="count">(%s)</span>', 'post status label including post count', 'woocommerce-subscriptions' ),
'wc-switched' => _nx_noop( 'Switched <span class="count">(%s)</span>', 'Switched <span class="count">(%s)</span>', 'post status label including post count', 'woocommerce-subscriptions' ),
'wc-expired' => _nx_noop( 'Expired <span class="count">(%s)</span>', 'Expired <span class="count">(%s)</span>', 'post status label including post count', 'woocommerce-subscriptions' ),
'wc-pending-cancel' => _nx_noop( 'Pending Cancellation <span class="count">(%s)</span>', 'Pending Cancellation <span class="count">(%s)</span>', 'post status label including post count', 'woocommerce-subscriptions' ),
) );
if ( is_array( $subscription_statuses ) && is_array( $registered_statuses ) ) {
foreach ( $registered_statuses as $status => $label_count ) {
register_post_status( $status, array(
'label' => $subscription_statuses[ $status ], // use same label/translations as wcs_get_subscription_statuses()
'public' => false,
'exclude_from_search' => false,
'show_in_admin_all_list' => true,
'show_in_admin_status_list' => true,
'label_count' => $label_count,
) );
}
}
}
/**
* Enqueues stylesheet for the My Subscriptions table on the My Account page.
*
* @since 1.5
*/
public static function enqueue_styles( $styles ) {
if ( is_checkout() || is_cart() ) {
$styles['wcs-checkout'] = array(
'src' => str_replace( array( 'http:', 'https:' ), '', plugin_dir_url( __FILE__ ) ) . 'assets/css/checkout.css',
'deps' => 'wc-checkout',
'version' => WC_VERSION,
'media' => 'all',
);
} elseif ( is_account_page() ) {
$styles['wcs-view-subscription'] = array(
'src' => str_replace( array( 'http:', 'https:' ), '', plugin_dir_url( __FILE__ ) ) . 'assets/css/view-subscription.css',
'deps' => 'woocommerce-smallscreen',
'version' => self::$version,
'media' => 'only screen and (max-width: ' . apply_filters( 'woocommerce_style_smallscreen_breakpoint', $breakpoint = '768px' ) . ')',
);
}
return $styles;
}
/**
* Loads the my-subscriptions.php template on the My Account page.
*
* @since 1.0
*/
public static function get_my_subscriptions_template() {
$subscriptions = wcs_get_users_subscriptions();
$user_id = get_current_user_id();
wc_get_template( 'myaccount/my-subscriptions.php', array( 'subscriptions' => $subscriptions, 'user_id' => $user_id ), '', plugin_dir_path( __FILE__ ) . 'templates/' );
}
/**
* Output a redirect URL when an item is added to the cart when a subscription was already in the cart.
*
* @since 1.0
*/
public static function redirect_ajax_add_to_cart( $fragments ) {
$data = array(
'error' => true,
'product_url' => WC()->cart->get_cart_url(),
);
return $data;
}
/**
* When a subscription is added to the cart, remove other products/subscriptions to
* work with PayPal Standard, which only accept one subscription per checkout.
*
* If multiple purchase flag is set, allow them to be added at the same time.
*
* @since 1.0
*/
public static function maybe_empty_cart( $valid, $product_id, $quantity, $variation_id = '' ) {
$is_subscription = WC_Subscriptions_Product::is_subscription( $product_id );
$cart_contains_subscription = WC_Subscriptions_Cart::cart_contains_subscription();
$multiple_subscriptions_possible = WC_Subscriptions_Payment_Gateways::one_gateway_supports( 'multiple_subscriptions' );
$manual_renewals_enabled = ( 'yes' == get_option( WC_Subscriptions_Admin::$option_prefix . '_accept_manual_renewals', 'no' ) ) ? true : false;
$canonical_product_id = ( ! empty( $variation_id ) ) ? $variation_id : $product_id;
if ( $is_subscription && 'yes' != get_option( WC_Subscriptions_Admin::$option_prefix . '_multiple_purchase', 'no' ) ) {
WC()->cart->empty_cart();
} elseif ( $is_subscription && wcs_cart_contains_renewal() && ! $multiple_subscriptions_possible && ! $manual_renewals_enabled ) {
self::remove_subscriptions_from_cart();
self::add_notice( __( 'A subscription renewal has been removed from your cart. Multiple subscriptions can not be purchased at the same time.', 'woocommerce-subscriptions' ), 'notice' );
} elseif ( $is_subscription && $cart_contains_subscription && ! $multiple_subscriptions_possible && ! $manual_renewals_enabled && ! WC_Subscriptions_Cart::cart_contains_product( $canonical_product_id ) ) {
self::remove_subscriptions_from_cart();
self::add_notice( __( 'A subscription has been removed from your cart. Due to payment gateway restrictions, different subscription products can not be purchased at the same time.', 'woocommerce-subscriptions' ), 'notice' );
} elseif ( $cart_contains_subscription && 'yes' != get_option( WC_Subscriptions_Admin::$option_prefix . '_multiple_purchase', 'no' ) ) {
self::remove_subscriptions_from_cart();
self::add_notice( __( 'A subscription has been removed from your cart. Products and subscriptions can not be purchased at the same time.', 'woocommerce-subscriptions' ), 'notice' );
if ( WC_Subscriptions::is_woocommerce_pre( '3.0.8' ) ) {
// Redirect to cart page to remove subscription & notify shopper
add_filter( 'add_to_cart_fragments', __CLASS__ . '::redirect_ajax_add_to_cart' );
} else {
add_filter( 'woocommerce_add_to_cart_fragments', __CLASS__ . '::redirect_ajax_add_to_cart' );
}
}
return $valid;
}
/**
* Removes all subscription products from the shopping cart.
*
* @since 1.0
*/
public static function remove_subscriptions_from_cart() {
foreach ( WC()->cart->cart_contents as $cart_item_key => $cart_item ) {
if ( WC_Subscriptions_Product::is_subscription( $cart_item['data'] ) ) {
WC()->cart->set_quantity( $cart_item_key, 0 );
}
}
}
/**
* For a smoother sign up process, tell WooCommerce to redirect the shopper immediately to
* the checkout page after she clicks the "Sign Up Now" button
*
* Only enabled if multiple checkout is not enabled.
*
* @param string $url The cart redirect $url WooCommerce determined.
* @since 1.0
*/
public static function add_to_cart_redirect( $url ) {
// If product is of the subscription type
if ( isset( $_REQUEST['add-to-cart'] ) && is_numeric( $_REQUEST['add-to-cart'] ) && WC_Subscriptions_Product::is_subscription( (int) $_REQUEST['add-to-cart'] ) ) {
// Redirect to checkout if mixed checkout is disabled
if ( 'yes' != get_option( WC_Subscriptions_Admin::$option_prefix . '_multiple_purchase', 'no' ) ) {
wc_clear_notices();
$url = WC()->cart->get_checkout_url();
// Redirect to the same page (if the customer wouldn't be redirected to the cart) to ensure the cart widget loads correctly
} elseif ( 'yes' != get_option( 'woocommerce_cart_redirect_after_add' ) && self::is_woocommerce_pre( '2.5' ) ) {
$url = remove_query_arg( 'add-to-cart' );
}
}
return $url;
}
/**
* Override the WooCommerce "Place Order" text with "Sign Up Now"
*
* @since 1.0
*/
public static function order_button_text( $button_text ) {
global $product;
if ( WC_Subscriptions_Cart::cart_contains_subscription() ) {
$button_text = get_option( WC_Subscriptions_Admin::$option_prefix . '_order_button_text', __( 'Sign Up Now', 'woocommerce-subscriptions' ) );
}
return $button_text;
}
/**
* Load the subscription add_to_cart template.
*
* Use the same cart template for subscription as that which is used for simple products. Reduce code duplication
* and is made possible by the friendly actions & filters found through WC.
*
* Not using a custom template both prevents code duplication and helps future proof this extension from core changes.
*
* @since 1.0
*/
public static function subscription_add_to_cart() {
wc_get_template( 'single-product/add-to-cart/subscription.php', array(), '', plugin_dir_path( __FILE__ ) . 'templates/' );
}
/**
* Load the variable subscription add_to_cart template
*
* Use a very similar cart template as that of a variable product with added functionality.
*
* @since 2.0.9
*/
public static function variable_subscription_add_to_cart() {
global $product;
// Enqueue variation scripts
wp_enqueue_script( 'wc-add-to-cart-variation' );
// Get Available variations?
$get_variations = sizeof( $product->get_children() ) <= apply_filters( 'woocommerce_ajax_variation_threshold', 30, $product );
// Load the template
wc_get_template( 'single-product/add-to-cart/variable-subscription.php', array(
'available_variations' => $get_variations ? $product->get_available_variations() : false,
'attributes' => $product->get_variation_attributes(),
'selected_attributes' => $product->get_default_attributes(),
), '', plugin_dir_path( __FILE__ ) . 'templates/' );
}
/**
* Compatibility with WooCommerce On One Page Checkout.
*
* Use OPC's simple add to cart template for simple subscription products (to ensure data attributes required by OPC are added).
*
* Variable subscription products will be handled automatically because they identify as "variable" in response to is_type() method calls,
* which OPC uses.
*
* @since 1.5.16
*/
public static function wcopc_subscription_add_to_cart() {
global $product;
wc_get_template( 'checkout/add-to-cart/simple.php', array( 'product' => $product ), '', PP_One_Page_Checkout::$template_path );
}
/**
* Takes a number and returns the number with its relevant suffix appended, eg. for 2, the function returns 2nd
*
* @since 1.0
*/
public static function append_numeral_suffix( $number ) {
// Handle teens: if the tens digit of a number is 1, then write "th" after the number. For example: 11th, 13th, 19th, 112th, 9311th. http://en.wikipedia.org/wiki/English_numerals
if ( strlen( $number ) > 1 && 1 == substr( $number, -2, 1 ) ) {
// translators: placeholder is a number, this is for the teens
$number_string = sprintf( __( '%sth', 'woocommerce-subscriptions' ), $number );
} else { // Append relevant suffix
switch ( substr( $number, -1 ) ) {
case 1:
// translators: placeholder is a number, numbers ending in 1
$number_string = sprintf( __( '%sst', 'woocommerce-subscriptions' ), $number );
break;
case 2:
// translators: placeholder is a number, numbers ending in 2
$number_string = sprintf( __( '%snd', 'woocommerce-subscriptions' ), $number );
break;
case 3:
// translators: placeholder is a number, numbers ending in 3
$number_string = sprintf( __( '%srd', 'woocommerce-subscriptions' ), $number );
break;
default:
// translators: placeholder is a number, numbers ending in 4-9, 0
$number_string = sprintf( __( '%sth', 'woocommerce-subscriptions' ), $number );
break;
}
}
return apply_filters( 'woocommerce_numeral_suffix', $number_string, $number );
}
/*
* Plugin House Keeping
*/
/**
* Called when WooCommerce is inactive or running and out-of-date version to display an inactive notice.
*
* @since 1.2
*/
public static function woocommerce_inactive_notice() {
if ( current_user_can( 'activate_plugins' ) ) :
if ( ! is_woocommerce_active() ) : ?>
<div id="message" class="error">
<p><?php
$install_url = wp_nonce_url( add_query_arg( array( 'action' => 'install-plugin', 'plugin' => 'woocommerce' ), admin_url( 'update.php' ) ), 'install-plugin_woocommerce' );
// translators: 1$-2$: opening and closing <strong> tags, 3$-4$: link tags, takes to woocommerce plugin on wp.org, 5$-6$: opening and closing link tags, leads to plugins.php in admin
printf( esc_html__( '%1$sWooCommerce Subscriptions is inactive.%2$s The %3$sWooCommerce plugin%4$s must be active for WooCommerce Subscriptions to work. Please %5$sinstall & activate WooCommerce »%6$s', 'woocommerce-subscriptions' ), '<strong>', '</strong>', '<a href="http://wordpress.org/extend/plugins/woocommerce/">', '</a>', '<a href="' . esc_url( $install_url ) . '">', '</a>' ); ?>
</p>
</div>
<?php elseif ( version_compare( get_option( 'woocommerce_db_version' ), '2.4', '<' ) ) : ?>
<div id="message" class="error">
<p><?php
// translators: 1$-2$: opening and closing <strong> tags, 3$-4$: opening and closing link tags, leads to plugin admin
printf( esc_html__( '%1$sWooCommerce Subscriptions is inactive.%2$s This version of Subscriptions requires WooCommerce 2.4 or newer. Please %3$supdate WooCommerce to version 2.4 or newer »%4$s', 'woocommerce-subscriptions' ), '<strong>', '</strong>', '<a href="' . esc_url( admin_url( 'plugins.php' ) ) . '">', '</a>' ); ?>
</p>
</div>
<?php endif; ?>
<?php endif;
}
/**
* Checks on each admin page load if Subscriptions plugin is activated.
*
* Apparently the official WP API is "lame" and it's far better to use an upgrade routine fired on admin_init: http://core.trac.wordpress.org/ticket/14170
*
* @since 1.1
*/
public static function maybe_activate_woocommerce_subscriptions() {
$is_active = get_option( WC_Subscriptions_Admin::$option_prefix . '_is_active', false );
if ( false == $is_active ) {
// Add the "Subscriptions" product type
if ( ! get_term_by( 'slug', self::$name, 'product_type' ) ) {
wp_insert_term( self::$name, 'product_type' );
}
// Maybe add the "Variable Subscriptions" product type
if ( ! get_term_by( 'slug', 'variable-subscription', 'product_type' ) ) {
wp_insert_term( __( 'Variable Subscription', 'woocommerce-subscriptions' ), 'product_type' );
}
// If no Subscription settings exist, its the first activation, so add defaults
if ( get_option( WC_Subscriptions_Admin::$option_prefix . '_cancelled_role', false ) == false ) {
WC_Subscriptions_Admin::add_default_settings();
}
// if this is the first time activating WooCommerce Subscription we want to enable PayPal debugging by default.
if ( '0' == get_option( WC_Subscriptions_Admin::$option_prefix . '_previous_version', '0' ) && false == get_option( WC_Subscriptions_admin::$option_prefix . '_paypal_debugging_default_set', false ) ) {
$paypal_settings = get_option( 'woocommerce_paypal_settings' );
$paypal_settings['debug'] = 'yes';
update_option( 'woocommerce_paypal_settings', $paypal_settings );
update_option( WC_Subscriptions_admin::$option_prefix . '_paypal_debugging_default_set', 'true' );
}
add_option( WC_Subscriptions_Admin::$option_prefix . '_is_active', true );
set_transient( self::$activation_transient, true, 60 * 60 );
flush_rewrite_rules();
do_action( 'woocommerce_subscriptions_activated' );
}
}
/**
* Called when the plugin is deactivated. Deletes the subscription product type and fires an action.
*
* @since 1.0
*/
public static function deactivate_woocommerce_subscriptions() {
delete_option( WC_Subscriptions_Admin::$option_prefix . '_is_active' );
flush_rewrite_rules();
do_action( 'woocommerce_subscriptions_deactivated' );
}
/**
* Called on plugins_loaded to load any translation files.
*
* @since 1.1
*/
public static function load_plugin_textdomain() {
$plugin_rel_path = apply_filters( 'woocommerce_subscriptions_translation_file_rel_path', dirname( plugin_basename( __FILE__ ) ) . '/languages' );
// Then check for a language file in /wp-content/plugins/woocommerce-subscriptions/languages/ (this will be overriden by any file already loaded)
load_plugin_textdomain( 'woocommerce-subscriptions', false, $plugin_rel_path );
}
/**
* Loads classes that depend on WooCommerce base classes.
*
* @since 1.2.4
*/
public static function load_dependant_classes() {
require_once( 'includes/class-wc-subscription.php' );
require_once( 'includes/class-wc-product-subscription.php' );
require_once( 'includes/class-wc-product-subscription-variation.php' );
require_once( 'includes/class-wc-product-variable-subscription.php' );
require_once( 'includes/admin/class-wcs-admin-post-types.php' );
require_once( 'includes/admin/class-wcs-admin-meta-boxes.php' );
require_once( 'includes/admin/class-wcs-admin-reports.php' );
require_once( 'includes/admin/reports/class-wcs-report-cache-manager.php' );
require_once( 'includes/admin/meta-boxes/class-wcs-meta-box-related-orders.php' );
require_once( 'includes/admin/meta-boxes/class-wcs-meta-box-subscription-data.php' );
require_once( 'includes/admin/meta-boxes/class-wcs-meta-box-subscription-schedule.php' );
require_once( 'includes/class-wcs-change-payment-method-admin.php' );
require_once( 'includes/class-wcs-webhooks.php' );
require_once( 'includes/class-wcs-auth.php' );
require_once( 'includes/class-wcs-api.php' );
require_once( 'includes/class-wcs-template-loader.php' );
require_once( 'includes/class-wcs-query.php' );
require_once( 'includes/class-wcs-remove-item.php' );
require_once( 'includes/class-wcs-user-change-status-handler.php' );
require_once( 'includes/class-wcs-my-account-payment-methods.php' );
if ( self::is_woocommerce_pre( '3.0' ) ) {
require_once( 'includes/legacy/class-wc-subscription-legacy.php' );
require_once( 'includes/legacy/class-wcs-product-legacy.php' );
require_once( 'includes/legacy/class-wc-product-subscription-legacy.php' );
require_once( 'includes/legacy/class-wc-product-subscription-variation-legacy.php' );
require_once( 'includes/legacy/class-wc-product-variable-subscription-legacy.php' );
// Load WC_DateTime when it doesn't exist yet so we can use it for datetime handling consistently with WC 3.0+
if ( ! class_exists( 'WC_DateTime' ) ) {
require_once( 'includes/libraries/class-wc-datetime.php' );
}
} else {
require_once( 'includes/class-wc-order-item-pending-switch.php' );
require_once( 'includes/data-stores/class-wcs-subscription-data-store-cpt.php' );
require_once( 'includes/deprecated/class-wcs-deprecated-filter-hooks.php' );
}
// Provide a hook to enable running deprecation handling for stores that might want to check for deprecated code
if ( apply_filters( 'woocommerce_subscriptions_load_deprecation_handlers', false ) ) {
require_once( 'includes/abstracts/abstract-wcs-hook-deprecator.php' );
require_once( 'includes/abstracts/abstract-wcs-dynamic-hook-deprecator.php' );
require_once( 'includes/deprecated/class-wcs-action-deprecator.php' );
require_once( 'includes/deprecated/class-wcs-filter-deprecator.php' );
require_once( 'includes/deprecated/class-wcs-dynamic-action-deprecator.php' );
require_once( 'includes/deprecated/class-wcs-dynamic-filter-deprecator.php' );
}
}
/**
* Some hooks need to check for the version of WooCommerce, which we can only do after WooCommerce is loaded.
*
* @since 1.5.17
*/
public static function attach_dependant_hooks() {
// Redirect the user immediately to the checkout page after clicking "Sign Up Now" buttons to encourage immediate checkout
add_filter( 'woocommerce_add_to_cart_redirect', __CLASS__ . '::add_to_cart_redirect' );
if ( self::is_woocommerce_pre( '2.6' ) ) {
// Display Subscriptions on a User's account page
add_action( 'woocommerce_before_my_account', __CLASS__ . '::get_my_subscriptions_template' );
}
}
/**
* Displays a notice when Subscriptions is being run on a different site, like a staging or testing site.
*
* @since 1.3.8
*/
public static function woocommerce_site_change_notice() {
if ( self::is_duplicate_site() && current_user_can( 'manage_options' ) ) {
if ( ! empty( $_REQUEST['_wcsnonce'] ) && wp_verify_nonce( $_REQUEST['_wcsnonce'], 'wcs_duplicate_site' ) && isset( $_GET['wc_subscription_duplicate_site'] ) ) {
if ( 'update' === $_GET['wc_subscription_duplicate_site'] ) {
WC_Subscriptions::set_duplicate_site_url_lock();
} elseif ( 'ignore' === $_GET['wc_subscription_duplicate_site'] ) {
update_option( 'wcs_ignore_duplicate_siteurl_notice', self::get_current_sites_duplicate_lock() );
}
wp_safe_redirect( remove_query_arg( array( 'wc_subscription_duplicate_site', '_wcsnonce' ) ) );
} elseif ( self::get_current_sites_duplicate_lock() !== get_option( 'wcs_ignore_duplicate_siteurl_notice' ) ) { ?>
<div id="message" class="error">
<p><?php
// translators: 1$-2$: opening and closing <strong> tags, 3$-4$: opening and closing link tags. Leads to duplicate site article on docs
printf( esc_html__( 'It looks like this site has moved or is a duplicate site. %1$sWooCommerce Subscriptions%2$s has disabled automatic payments and subscription related emails on this site to prevent duplicate payments from a staging or test environment. %3$sLearn more »%4$s.', 'woocommerce-subscriptions' ), '<strong>', '</strong>', '<a href="http://docs.woocommerce.com/document/subscriptions/faq/#section-39" target="_blank">', '</a>' ); ?></p>
<div style="margin: 5px 0;">
<a class="button button-primary" href="<?php echo esc_url( wp_nonce_url( add_query_arg( 'wc_subscription_duplicate_site', 'ignore' ), 'wcs_duplicate_site', '_wcsnonce' ) ); ?>"><?php esc_html_e( 'Quit nagging me (but don\'t enable automatic payments)', 'woocommerce-subscriptions' ); ?></a>
<a class="button" href="<?php echo esc_url( wp_nonce_url( add_query_arg( 'wc_subscription_duplicate_site', 'update' ), 'wcs_duplicate_site', '_wcsnonce' ) ); ?>"><?php esc_html_e( 'Enable automatic payments', 'woocommerce-subscriptions' ); ?></a>
</div>
</div>
<?php
}
}
}
/**
* Get's a WC_Product using the new core WC @see wc_get_product() function if available, otherwise
* instantiating an instance of the WC_Product class.
*
* @since 1.2.4
*/
public static function get_product( $product_id ) {
if ( function_exists( 'wc_get_product' ) ) {
$product = wc_get_product( $product_id );
} else {
$product = new WC_Product( $product_id ); // Shouldn't matter if product is variation as all we need is the product_type
}
return $product;
}
/**
* A general purpose function for grabbing an array of subscriptions in form of 'subscription_key' => 'subscription_details'.
*
* The $args param is based on the parameter of the same name used by the core WordPress @see get_posts() function.
* It can be used to choose which subscriptions should be returned by the function, how many subscriptions should be returned
* and in what order those subscriptions should be returned.
*
* @param array $args A set of name value pairs to determine the return value.
* 'subscriptions_per_page' The number of subscriptions to return. Set to -1 for unlimited. Default 10.
* 'offset' An optional number of subscription to displace or pass over. Default 0.
* 'orderby' The field which the subscriptions should be ordered by. Can be 'start_date', 'expiry_date', 'end_date', 'status', 'name' or 'order_id'. Defaults to 'start_date'.
* 'order' The order of the values returned. Can be 'ASC' or 'DESC'. Defaults to 'DESC'
* 'customer_id' The user ID of a customer on the site.
* 'product_id' The post ID of a WC_Product_Subscription, WC_Product_Variable_Subscription or WC_Product_Subscription_Variation object
* 'subscription_status' Any valid subscription status. Can be 'any', 'active', 'cancelled', 'suspended', 'expired', 'pending' or 'trash'. Defaults to 'any'.
* @return array Subscription details in 'subscription_key' => 'subscription_details' form.
* @since 1.4
*/
public static function get_subscriptions( $args = array() ) {
if ( isset( $args['orderby'] ) ) {
// Although most of these weren't public orderby values, they were used internally so may have been used by developers
switch ( $args['orderby'] ) {
case '_subscription_status' :
_deprecated_argument( __METHOD__, '2.0', 'The "_subscription_status" orderby value is deprecated. Use "status" instead.' );
$args['orderby'] = 'status';
break;
case '_subscription_start_date' :
_deprecated_argument( __METHOD__, '2.0', 'The "_subscription_start_date" orderby value is deprecated. Use "start_date" instead.' );
$args['orderby'] = 'start_date';
break;
case 'expiry_date' :
case '_subscription_expiry_date' :
case '_subscription_end_date' :
_deprecated_argument( __METHOD__, '2.0', 'The expiry date orderby value is deprecated. Use "end_date" instead.' );
$args['orderby'] = 'end_date';
break;
case 'trial_expiry_date' :
case '_subscription_trial_expiry_date' :
_deprecated_argument( __METHOD__, '2.0', 'The trial expiry date orderby value is deprecated. Use "trial_end_date" instead.' );
$args['orderby'] = 'trial_end_date';
break;
case 'name' :
_deprecated_argument( __METHOD__, '2.0', 'The "name" orderby value is deprecated - subscriptions no longer have just one name as they may contain multiple items.' );
break;
}
}
_deprecated_function( __METHOD__, '2.0', 'wcs_get_subscriptions( $args )' );
$subscriptions = wcs_get_subscriptions( $args );
$subscriptions_in_deprecated_structure = array();
// Get the subscriptions in the backward compatible structure
foreach ( $subscriptions as $subscription ) {
$subscriptions_in_deprecated_structure[ wcs_get_old_subscription_key( $subscription ) ] = wcs_get_subscription_in_deprecated_structure( $subscription );
}
return apply_filters( 'woocommerce_get_subscriptions', $subscriptions_in_deprecated_structure, $args );
}
/**
* Returns the longest possible time period
*
* @since 1.3
*/
public static function get_longest_period( $current_period, $new_period ) {
if ( empty( $current_period ) || 'year' == $new_period ) {
$longest_period = $new_period;
} elseif ( 'month' === $new_period && in_array( $current_period, array( 'week', 'day' ) ) ) {
$longest_period = $new_period;
} elseif ( 'week' === $new_period && 'day' === $current_period ) {
$longest_period = $new_period;
} else {
$longest_period = $current_period;
}
return $longest_period;
}
/**
* Returns the shortest possible time period
*
* @since 1.3.7
*/
public static function get_shortest_period( $current_period, $new_period ) {
if ( empty( $current_period ) || 'day' == $new_period ) {
$shortest_period = $new_period;
} elseif ( 'week' === $new_period && in_array( $current_period, array( 'month', 'year' ) ) ) {
$shortest_period = $new_period;
} elseif ( 'month' === $new_period && 'year' === $current_period ) {
$shortest_period = $new_period;
} else {
$shortest_period = $current_period;
}
return $shortest_period;
}
/**
* Returns Subscriptions record of the site URL for this site
*
* @since 1.3.8
*/
public static function get_site_url( $blog_id = null, $path = '', $scheme = null ) {
if ( empty( $blog_id ) || ! is_multisite() ) {
$url = get_option( 'wc_subscriptions_siteurl' );
} else {
switch_to_blog( $blog_id );
$url = get_option( 'wc_subscriptions_siteurl' );
restore_current_blog();
}
// Remove the prefix used to prevent the site URL being updated on WP Engine
$url = str_replace( '_[wc_subscriptions_siteurl]_', '', $url );
$url = set_url_scheme( $url, $scheme );
if ( ! empty( $path ) && is_string( $path ) && strpos( $path, '..' ) === false ) {
$url .= '/' . ltrim( $path, '/' );
}
return apply_filters( 'wc_subscriptions_site_url', $url, $path, $scheme, $blog_id );
}
/**
* Checks if the WordPress site URL is the same as the URL for the site subscriptions normally
* runs on. Useful for checking if automatic payments should be processed.
*
* @since 1.3.8
*/
public static function is_duplicate_site() {
if ( defined( 'WP_SITEURL' ) ) {
$site_url = WP_SITEURL;
} else {
$site_url = get_site_url();
}
$wp_site_url_parts = wp_parse_url( $site_url );
$wcs_site_url_parts = wp_parse_url( self::get_site_url() );
if ( ! isset( $wp_site_url_parts['path'] ) && ! isset( $wcs_site_url_parts['path'] ) ) {
$paths_match = true;
} elseif ( isset( $wp_site_url_parts['path'] ) && isset( $wcs_site_url_parts['path'] ) && $wp_site_url_parts['path'] == $wcs_site_url_parts['path'] ) {
$paths_match = true;
} else {
$paths_match = false;
}
if ( isset( $wp_site_url_parts['host'] ) && isset( $wcs_site_url_parts['host'] ) && $wp_site_url_parts['host'] == $wcs_site_url_parts['host'] ) {