class-wc-subscriptions-renewal-order.php
26.4 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
<?php
/**
* Subscriptions Renewal Order Class
*
* Provides an API for creating and handling renewal orders.
*
* @package WooCommerce Subscriptions
* @subpackage WC_Subscriptions_Order
* @category Class
* @author Brent Shepherd
* @since 1.2
*/
class WC_Subscriptions_Renewal_Order {
/**
* Bootstraps the class and hooks required actions & filters.
*
* @since 1.0
*/
public static function init() {
// Trigger special hook when payment is completed on renewal orders
add_action( 'woocommerce_payment_complete', __CLASS__ . '::trigger_renewal_payment_complete', 10 );
// When a renewal order's status changes, check if a corresponding subscription's status should be changed by marking it as paid (we can't use the 'woocommerce_payment_complete' here because it's not triggered by all payment gateways)
add_filter( 'woocommerce_order_status_changed', __CLASS__ . '::maybe_record_subscription_payment', 10, 3 );
add_filter( 'wcs_renewal_order_created', __CLASS__ . '::add_order_note', 10, 2 );
// Prevent customers from cancelling renewal orders. Needs to be hooked before WC_Form_Handler::cancel_order() (20)
add_filter( 'wp_loaded', __CLASS__ . '::prevent_cancelling_renewal_orders', 19, 3 );
}
/* Helper functions */
/**
* Trigger a special hook for payments on a completed renewal order.
*
* @since 1.5.4
*/
public static function trigger_renewal_payment_complete( $order_id ) {
if ( wcs_order_contains_renewal( $order_id ) ) {
do_action( 'woocommerce_renewal_order_payment_complete', $order_id );
}
}
/**
* Check if a given renewal order was created to replace a failed renewal order.
*
* @since 1.5.12
* @param int ID of the renewal order you want to check against
* @return mixed If the renewal order did replace a failed order, the ID of the fail order, else false
*/
public static function get_failed_order_replaced_by( $renewal_order_id ) {
global $wpdb;
$failed_order_id = $wpdb->get_var( $wpdb->prepare( "SELECT post_id FROM $wpdb->postmeta WHERE meta_key = '_failed_order_replaced_by' AND meta_value = %s", $renewal_order_id ) );
return ( null === $failed_order_id ) ? false : $failed_order_id;
}
/**
* Whenever a renewal order's status is changed, check if a corresponding subscription's status should be changed
*
* This function is hooked to 'woocommerce_order_status_changed', rather than 'woocommerce_payment_complete', to ensure
* subscriptions are updated even if payment is processed by a manual payment gateways (which would never trigger the
* 'woocommerce_payment_complete' hook) or by some other means that circumvents that hook.
*
* @since 2.0
*/
public static function maybe_record_subscription_payment( $order_id, $orders_old_status, $orders_new_status ) {
if ( ! wcs_order_contains_renewal( $order_id ) ) {
return;
}
$subscriptions = wcs_get_subscriptions_for_renewal_order( $order_id );
$was_activated = false;
$order_completed = in_array( $orders_new_status, array( apply_filters( 'woocommerce_payment_complete_order_status', 'processing', $order_id ), 'processing', 'completed' ) );
$order_needed_payment = in_array( $orders_old_status, apply_filters( 'woocommerce_valid_order_statuses_for_payment', array( 'pending', 'on-hold', 'failed' ) ) );
foreach ( $subscriptions as $subscription ) {
// Do we need to activate a subscription?
if ( $order_completed && ! $subscription->has_status( wcs_get_subscription_ended_statuses() ) && ! $subscription->has_status( 'active' ) ) {
if ( $order_needed_payment ) {
$subscription->payment_complete();
$was_activated = true;
}
if ( 'failed' === $orders_old_status ) {
do_action( 'woocommerce_subscriptions_paid_for_failed_renewal_order', wc_get_order( $order_id ), $subscription );
}
} elseif ( 'failed' == $orders_new_status ) {
$subscription->payment_failed();
}
}
if ( $was_activated ) {
do_action( 'subscriptions_activated_for_order', $order_id );
}
}
/**
* Add order note to subscription to record the renewal order
*
* @param WC_Order|int $renewal_order
* @param WC_Subscription|int $subscription
* @since 2.0
*/
public static function add_order_note( $renewal_order, $subscription ) {
if ( ! is_object( $subscription ) ) {
$subscription = wcs_get_subscription( $subscription );
}
if ( ! is_object( $renewal_order ) ) {
$renewal_order = wc_get_order( $renewal_order );
}
if ( is_a( $renewal_order, 'WC_Order' ) && wcs_is_subscription( $subscription ) ) {
$order_number = sprintf( _x( '#%s', 'hash before order number', 'woocommerce-subscriptions' ), $renewal_order->get_order_number() );
// translators: placeholder is order ID
$subscription->add_order_note( sprintf( __( 'Order %s created to record renewal.', 'woocommerce-subscriptions' ), sprintf( '<a href="%s">%s</a> ', esc_url( wcs_get_edit_post_link( $renewal_order->id ) ), $order_number ) ) );
}
return $renewal_order;
}
/**
* Do not allow customers to cancel renewal orders.
*
* @since 2.0
*/
public static function prevent_cancelling_renewal_orders() {
if ( isset( $_GET['cancel_order'] ) && isset( $_GET['order'] ) && isset( $_GET['order_id'] ) ) {
$order_id = absint( $_GET['order_id'] );
$order = wc_get_order( $order_id );
$redirect = $_GET['redirect'];
if ( wcs_order_contains_renewal( $order ) ) {
remove_action( 'wp_loaded', 'WC_Form_Handler::cancel_order', 20 );
wc_add_notice( __( 'Subscription renewal orders cannot be cancelled.', 'woocommerce-subscriptions' ), 'notice' );
if ( $redirect ) {
wp_safe_redirect( $redirect );
exit;
}
}
}
}
/* Deprecated functions */
/**
* Hooks to the renewal order created action to determine if the order should be emailed to the customer.
*
* @param WC_Order|int $order The WC_Order object or ID of a WC_Order order.
* @since 1.2
* @deprecated 1.4
*/
public static function maybe_send_customer_renewal_order_email( $order ) {
_deprecated_function( __METHOD__, '1.4' );
if ( 'yes' == get_option( WC_Subscriptions_Admin::$option_prefix . '_email_renewal_order' ) ) {
self::send_customer_renewal_order_email( $order );
}
}
/**
* Processing Order
*
* @param WC_Order|int $order The WC_Order object or ID of a WC_Order order.
* @since 1.2
* @deprecated 1.4
*/
public static function send_customer_renewal_order_email( $order ) {
_deprecated_function( __METHOD__, '1.4' );
if ( ! is_object( $order ) ) {
$order = new WC_Order( $order );
}
$mailer = WC()->mailer();
$mails = $mailer->get_emails();
$mails['WCS_Email_Customer_Renewal_Invoice']->trigger( $order->id );
}
/**
* Change the email subject of the new order email to specify the order is a subscription renewal order
*
* @param string $subject The default WooCommerce email subject
* @param WC_Order $order The WC_Order object which the email relates to
* @since 1.2
* @deprecated 1.4
*/
public static function email_subject_new_renewal_order( $subject, $order ) {
_deprecated_function( __METHOD__, '1.4' );
if ( wcs_order_contains_renewal( $order ) ) {
$blogname = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
// translators: 1$: blog name, 2$: order number
$subject = apply_filters( 'woocommerce_subscriptions_email_subject_new_renewal_order', sprintf( _x( '[%1$s] New Subscription Renewal Order (%2$s)', 'used in new renewal order email, deprecated', 'woocommerce-subscriptions' ), $blogname, $order->get_order_number() ), $order );
}
return $subject;
}
/**
* Change the email subject of the processing order email to specify the order is a subscription renewal order
*
* @param string $subject The default WooCommerce email subject
* @param WC_Order $order The WC_Order object which the email relates to
* @since 1.2
* @deprecated 1.4
*/
public static function email_subject_customer_procesing_renewal_order( $subject, $order ) {
_deprecated_function( __METHOD__, '1.4' );
if ( wcs_order_contains_renewal( $order ) ) {
$blogname = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
$subject = apply_filters(
'woocommerce_subscriptions_email_subject_customer_procesing_renewal_order',
// translators: placeholder is blog name
sprintf( _x( '[%s] Subscription Renewal Order', 'used as email subject for renewal order notification email to customer', 'woocommerce-subscriptions' ), $blogname ),
$order
);
}
return $subject;
}
/**
* Change the email subject of the completed order email to specify the order is a subscription renewal order
*
* @param string $subject The default WooCommerce email subject
* @param WC_Order $order The WC_Order object which the email relates to
* @since 1.2
* @deprecated 1.4
*/
public static function email_subject_customer_completed_renewal_order( $subject, $order ) {
_deprecated_function( __METHOD__, '1.4' );
if ( wcs_order_contains_renewal( $order ) ) {
$blogname = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
$subject = apply_filters(
'woocommerce_subscriptions_email_subject_customer_completed_renewal_order',
// translators: placeholder is blog name
sprintf( _x( '[%s] Subscription Renewal Order', 'used as email subject for renewal order notification email to customer', 'woocommerce-subscriptions' ), $blogname ),
$order
);
}
return $subject;
}
/**
* Generate an order to record an automatic subscription payment.
*
* This function is hooked to the 'process_subscription_payment' which is fired when a payment gateway calls
* the @see WC_Subscriptions_Manager::process_subscription_payment() function. Because manual payments will
* also call this function, the function only generates a renewal order if the @see WC_Order::payment_complete()
* will be called for the renewal order.
*
* @param int $user_id The id of the user who purchased the subscription
* @param string $subscription_key A subscription key of the form created by @see WC_Subscriptions_Manager::get_subscription_key()
* @since 1.2
* @deprecated 2.0
*/
public static function generate_paid_renewal_order( $user_id, $subscription_key ) {
_deprecated_function( __METHOD__, '2.0', 'wcs_create_renewal_order( WC_Subscription $subscription )' );
$subscription = wcs_get_subscription_from_key( $subscription_key );
$renewal_order = wcs_create_renewal_order( $subscription );
$renewal_order->payment_complete();
return $renewal_order->id;
}
/**
* Generate an order to record a subscription payment failure.
*
* This function is hooked to the 'processed_subscription_payment_failure' hook called when a payment
* gateway calls the @see WC_Subscriptions_Manager::process_subscription_payment_failure()
*
* @param int $user_id The id of the user who purchased the subscription
* @param string $subscription_key A subscription key of the form created by @see WC_Subscriptions_Manager::get_subscription_key()
* @since 1.2
* @deprecated 2.0
*/
public static function generate_failed_payment_renewal_order( $user_id, $subscription_key ) {
_deprecated_function( __METHOD__, '2.0', 'wcs_create_renewal_order( WC_Subscription $subscription )' );
$renewal_order = wcs_create_renewal_order( wcs_get_subscription_from_key( $subscription_key ) );
$renewal_order->update_status( 'failed' );
return $renewal_order->id;
}
/**
* Generate an order to record a subscription payment.
*
* This function is hooked to the scheduled subscription payment hook to create a pending
* order for each scheduled subscription payment.
*
* When a payment gateway calls the @see WC_Subscriptions_Manager::process_subscription_payment()
* @see WC_Order::payment_complete() will be called for the renewal order.
*
* @param int $user_id The id of the user who purchased the subscription
* @param string $subscription_key A subscription key of the form created by @see WC_Subscriptions_Manager::get_subscription_key()
* @since 1.2
*/
public static function maybe_generate_manual_renewal_order( $user_id, $subscription_key ) {
_deprecated_function( __METHOD__, '2.0', __CLASS__ . '::maybe_create_manual_renewal_order( WC_Subscription $subscription )' );
self::maybe_create_manual_renewal_order( wcs_get_subscription_from_key( $subscription_key ) )->id;
}
/**
* Get the ID of the parent order for a subscription renewal order.
*
* Deprecated because a subscription's details are now stored in a WC_Subscription object, not the
* parent order.
*
* @param WC_Order|int $order The WC_Order object or ID of a WC_Order order.
* @since 1.2
* @deprecated 2.0
*/
public static function get_parent_order_id( $renewal_order ) {
_deprecated_function( __METHOD__, '2.0', 'wcs_get_subscriptions_for_renewal_order()' );
$parent_order = self::get_parent_order( $renewal_order );
return ( null === $parent_order ) ? null : $parent_order->id;
}
/**
* Get the parent order for a subscription renewal order.
*
* Deprecated because a subscription's details are now stored in a WC_Subscription object, not the
* parent order.
*
* @param WC_Order|int $order The WC_Order object or ID of a WC_Order order.
* @since 1.2
* @deprecated 2.0 self::get_parent_subscription() is the better function to use now as a renewal order
*/
public static function get_parent_order( $renewal_order ) {
_deprecated_function( __METHOD__, '2.0', 'wcs_get_subscriptions_for_renewal_order()' );
if ( ! is_object( $renewal_order ) ) {
$renewal_order = new WC_Order( $renewal_order );
}
$subscriptions = wcs_get_subscriptions_for_renewal_order( $renewal_order );
$subscription = array_pop( $subscriptions );
if ( false === $subscription->order ) { // There is no original order
$parent_order = null;
} else {
$parent_order = $subscription->order;
}
return apply_filters( 'woocommerce_subscriptions_parent_order', $parent_order, $renewal_order );
}
/**
* Returns the number of renewals for a given parent order
*
* @param int $order_id The ID of a WC_Order object.
* @since 1.2
* @deprecated 2.0
*/
public static function get_renewal_order_count( $order_id ) {
_deprecated_function( __METHOD__, '2.0', 'WC_Subscription::get_related_orders()' );
$subscriptions_for_order = wcs_get_subscriptions_for_order( $order_id, array( 'order_type' => 'parent' ) );
if ( ! empty( $subscriptions_for_order ) ) {
$subscription = array_pop( $subscriptions_for_order );
$all_orders = $subscription->get_related_orders();
$renewal_order_count = count( $all_orders );
// Don't include the initial order (if any)
if ( false !== $subscription->order ) {
$renewal_order_count -= 1;
}
} else {
$renewal_order_count = 0;
}
return apply_filters( 'woocommerce_subscriptions_renewal_order_count', $renewal_order_count, $order_id );
}
/**
* Returns a URL including required parameters for an authenticated user to renew a subscription
*
* Deprecated because the use of a $subscription_key is deprecated.
*
* @param string $subscription_key A subscription key of the form created by @see WC_Subscriptions_Manager::get_subscription_key()
* @since 1.2
* @deprecated 2.0
*/
public static function get_users_renewal_link( $subscription_key, $role = 'parent' ) {
_deprecated_function( __METHOD__, '2.0', 'wcs_get_users_resubscribe_link( $subscription )' );
return wcs_get_users_resubscribe_link( wcs_get_subscription_from_key( $subscription_key ) );
}
/**
* Returns a URL including required parameters for an authenticated user to renew a subscription by product ID.
*
* Deprecated because the use of a $subscription_key is deprecated.
*
* @param string $subscription_key A subscription key of the form created by @see WC_Subscriptions_Manager::get_subscription_key()
* @since 1.2
* @deprecated 2.0
*/
public static function get_users_renewal_link_for_product( $product_id ) {
_deprecated_function( __METHOD__, '2.0', 'wcs_get_users_resubscribe_link_for_product( $subscription )' );
return wcs_get_users_resubscribe_link_for_product( $product_id );
}
/**
* Check if a given subscription can be renewed.
*
* Deprecated because the use of a $subscription_key is deprecated.
*
* @param string $subscription_key A subscription key of the form created by @see WC_Subscriptions_Manager::get_subscription_key()
* @param int $user_id The ID of the user who owns the subscriptions. Although this parameter is optional, if you have the User ID you should pass it to improve performance.
* @since 1.2
* @deprecated 2.0
*/
public static function can_subscription_be_renewed( $subscription_key, $user_id = '' ) {
_deprecated_function( __METHOD__, '2.0', 'wcs_can_user_resubscribe_to( $subscription, $user_id )' );
return wcs_can_user_resubscribe_to( wcs_get_subscription_from_key( $subscription_key ), $user_id );
}
/**
* Checks if the current request is by a user to renew their subscription, and if it is
* set up a subscription renewal via the cart for the product/variation that is being renewed.
*
* @since 1.2
* @deprecated 2.0
*/
public static function maybe_create_renewal_order_for_user() {
_deprecated_function( __METHOD__, '2.0', 'WCS_Cart_Renewal::maybe_setup_resubscribe_via_cart()' );
}
/**
* When restoring the cart from the session, if the cart item contains addons, but is also
* a subscription renewal, do not adjust the price because the original order's price will
* be used, and this includes the addons amounts.
*
* @since 1.5.5
* @deprecated 2.0
*/
public static function product_addons_adjust_price( $adjust_price, $cart_item ) {
_deprecated_function( __METHOD__, '2.0', 'WCS_Cart_Renewal::product_addons_adjust_price()' );
}
/**
* Created a new order for renewing a subscription product based on the details of a previous order.
*
* @param WC_Order|int $order The WC_Order object or ID of the order for which the a new order should be created.
* @param string $product_id The ID of the subscription product in the order which needs to be added to the new order.
* @param array $args (optional) An array of name => value flags:
* 'new_order_role' string A flag to indicate whether the new order should become the master order for the subscription. Accepts either 'parent' or 'child'. Defaults to 'parent' - replace the existing order.
* 'checkout_renewal' bool Indicates if invoked from an interactive cart/checkout session and certain order items are not set, like taxes, shipping as they need to be set in teh calling function, like @see WC_Subscriptions_Checkout::filter_woocommerce_create_order(). Default false.
* 'failed_order_id' int For checkout_renewal true, indicates order id being replaced
* @since 1.2
* @deprecated 2.0
*/
public static function generate_renewal_order( $original_order, $product_id, $args = array() ) {
_deprecated_function( __METHOD__, '2.0', 'wcs_create_renewal_order() or wcs_create_resubscribe_order()' );
if ( ! wcs_order_contains_subscription( $original_order, 'parent' ) ) {
return false;
}
$args = wp_parse_args( $args, array(
'new_order_role' => 'parent',
'checkout_renewal' => false,
)
);
$subscriptions = wcs_get_subscriptions_for_order( $original_order, array( 'order_type' => 'parent' ) );
$subscription = array_shift( $subscriptions );
if ( 'parent' == $args['new_order_role'] ) {
$new_order = wcs_create_resubscribe_order( $subscription );
} else {
$new_order = wcs_create_renewal_order( $subscription );
}
return $new_order->id;
}
/**
* If a product is being marked as not purchasable because it is limited and the customer has a subscription,
* but the current request is to resubscribe to the subscription, then mark it as purchasable.
*
* @since 1.5
* @deprecated 2.0
*/
public static function is_purchasable( $is_purchasable, $product ) {
_deprecated_function( __METHOD__, '2.0', 'WCS_Cart_Renewal::is_purchasable()' );
return $is_purchasable;
}
/**
* Check if a given order is a subscription renewal order and optionally, if it is a renewal order of a certain role.
*
* @param WC_Order|int $order The WC_Order object or ID of a WC_Order order.
* @param array $args (optional) An array of name => value flags:
* 'order_role' string (optional) A specific role to check the order against. Either 'parent' or 'child'.
* 'via_checkout' Indicates whether to check if the renewal order was via the cart/checkout process.
* @since 1.2
*/
public static function is_renewal( $order, $args = array() ) {
$args = wp_parse_args( $args, array(
'order_role' => '',
'via_checkout' => false,
)
);
$is_resubscribe_order = wcs_order_contains_resubscribe( $order );
$is_renewal_order = wcs_order_contains_renewal( $order );
if ( empty( $args['new_order_role'] ) ) {
_deprecated_function( __METHOD__, '2.0', 'wcs_order_contains_resubscribe( $order ) and wcs_order_contains_renewal( $order )' );
return ( $is_resubscribe_order || $is_renewal_order );
} elseif ( 'parent' == $args['new_order_role'] ) {
_deprecated_function( __METHOD__, '2.0', 'wcs_order_contains_resubscribe( $order )' );
return $is_resubscribe_order;
} else {
_deprecated_function( __METHOD__, '2.0', 'wcs_order_contains_renewal( $order )' );
return $is_renewal_order;
}
}
/**
* Returns the renewal orders for a given parent order
*
* @param int $order_id The ID of a WC_Order object.
* @param string $output (optional) How you'd like the result. Can be 'ID' for IDs only or 'WC_Order' for order objects.
* @since 1.2
* @deprecated 2.0
*/
public static function get_renewal_orders( $order_id, $output = 'ID' ) {
_deprecated_function( __METHOD__, '2.0', 'WC_Subscription::get_related_orders()' );
$subscriptions = wcs_get_subscriptions_for_order( $order_id, array( 'order_type' => 'parent' ) );
$subscription = array_shift( $subscriptions );
if ( 'WC_Order' == $output ) {
$renewal_orders = $subscription->get_related_orders( 'all', 'renewal' );
} else {
$renewal_orders = $subscription->get_related_orders( 'ids', 'renewal' );
}
return apply_filters( 'woocommerce_subscriptions_renewal_orders', $renewal_orders, $order_id );
}
/**
* Flag payment of manual renewal orders.
*
* This is particularly important to ensure renewals of limited subscriptions can be completed.
*
* @since 1.5.5
* @deprecated 2.0
*/
public static function get_checkout_payment_url( $pay_url, $order ) {
_deprecated_function( __METHOD__, '2.0', 'WCS_Cart_Renewal::get_checkout_payment_url() or WCS_Cart_Resubscribe::get_checkout_payment_url()' );
return $pay_url;
}
/**
* Process a renewal payment when a customer has completed the payment for a renewal payment which previously failed.
*
* @since 1.3
* @deprecated 2.0
*/
public static function maybe_process_failed_renewal_order_payment( $order_id ) {
_deprecated_function( __METHOD__, '2.0', 'WCS_Cart_Renewal::maybe_change_subscription_status( $order_id, $orders_old_status, $orders_new_status )' );
}
/**
* If the payment for a renewal order has previously failed and is then paid, then the
* @see WC_Subscriptions_Manager::process_subscription_payments_on_order() function would
* never be called. This function makes sure it is called.
*
* @param WC_Order|int $order A WC_Order object or ID of a WC_Order order.
* @since 1.2
* @deprecated 2.0
*/
public static function process_failed_renewal_order_payment( $order_id ) {
_deprecated_function( __METHOD__, '2.0' );
if ( wcs_order_contains_renewal( $order_id ) ) {
$subscriptions = wcs_get_subscriptions_for_renewal_order( $order_id );
$subscription = array_pop( $subscriptions );
if ( $subscription->is_manual() ) {
add_action( 'woocommerce_payment_complete', __CLASS__ . '::process_subscription_payment_on_child_order', 10, 1 );
}
}
}
/**
* Records manual payment of a renewal order against a subscription.
*
* @param WC_Order|int $order A WC_Order object or ID of a WC_Order order.
* @since 1.2
* @deprecated 2.0
*/
public static function maybe_record_renewal_order_payment( $order_id ) {
_deprecated_function( __METHOD__, '2.0' );
if ( wcs_order_contains_renewal( $order_id ) ) {
$subscriptions = wcs_get_subscriptions_for_renewal_order( $order_id );
$subscription = array_pop( $subscriptions );
if ( $subscription->is_manual() ) {
self::process_subscription_payment_on_child_order( $order_id );
}
}
}
/**
* Records manual payment of a renewal order against a subscription.
*
* @param WC_Order|int $order A WC_Order object or ID of a WC_Order order.
* @since 1.2
* @deprecated 2.0
*/
public static function maybe_record_renewal_order_payment_failure( $order_id ) {
_deprecated_function( __METHOD__, '2.0' );
if ( wcs_order_contains_renewal( $order_id ) ) {
$subscriptions = wcs_get_subscriptions_for_renewal_order( $order_id );
$subscription = array_pop( $subscriptions );
if ( $subscription->is_manual() ) {
self::process_subscription_payment_on_child_order( $order_id, 'failed' );
}
}
}
/**
* If the payment for a renewal order has previously failed and is then paid, we need to make sure the
* subscription payment function is called.
*
* @param int $user_id The id of the user who purchased the subscription
* @param string $subscription_key A subscription key of the form created by @see WC_Subscriptions_Manager::get_subscription_key()
* @since 1.2
* @deprecated 2.0
*/
public static function process_subscription_payment_on_child_order( $order_id, $payment_status = 'completed' ) {
_deprecated_function( __METHOD__, '2.0' );
if ( wcs_order_contains_renewal( $order_id ) ) {
$subscriptions = wcs_get_subscriptions_for_renewal_order( $order_id );
foreach ( $subscriptions as $subscription ) {
if ( 'failed' == $payment_status ) {
$subscription->payment_failed();
} else {
$subscription->payment_complete();
$subscription->update_status( 'active' );
}
}
}
}
/**
* Adds a renewal orders section to the Related Orders meta box displayed on subscription orders.
*
* @deprecated 2.0
* @since 1.2
*/
public static function renewal_orders_meta_box_section( $order, $post ) {
_deprecated_function( __METHOD__, '2.0' );
}
/**
* Trigger a hook when a subscription suspended due to a failed renewal payment is reactivated
*
* @since 1.3
*/
public static function trigger_processed_failed_renewal_order_payment_hook( $user_id, $subscription_key ) {
_deprecated_function( __METHOD__, '2.0', __CLASS__ . '::maybe_record_subscription_payment( $order_id, $orders_old_status, $orders_new_status )' );
}
}
WC_Subscriptions_Renewal_Order::init();