PluginProbe
Subscriptions for WooCommerce with Stripe Recurring Payments / 2.0.0
Subscriptions for WooCommerce with Stripe Recurring Payments v2.0.0
2.0.0 1.11.2 1.11.1 1.11.0 1.10.9 1.10.8 1.10.7 1.10.6 1.10.5 1.10.4 1.10.3 1.10.2 1.10.1 1.10.0 1.9.6 1.9.5 trunk 1.3.0 1.3.1 1.3.2 1.4.0 1.4.1 1.4.2 1.5.0 1.5.1 All 61 releases
← All changes | includes/functions.php +309 -77 1.11.22.0.0 View file →
@@ -1,6 +1,16 @@
1 1 <?php
2 +/**
3 + * Global helper functions.
4 + *
5 + * @package SpringDevs\Subscription
6 + */
2 7
8 +// Exit if accessed directly.
9 +if ( ! defined( 'ABSPATH' ) ) {
10 + exit;
11 +}
12 +
3 13 use Automattic\WooCommerce\Internal\DataStores\Orders\CustomOrdersTableController;
4 14 use SpringDevs\Subscription\Illuminate\Subscription\Subscription;
5 15 use SpringDevs\Subscription\Utils\Product;
6 16
@@ -75,17 +85,263 @@
75 85 return class_exists( 'Sdevs_Wc_Subscription_Pro' );
76 86 }
77 87
78 88 /**
89 + * Whether a product is tied to at least one active subscription plan.
90 + *
91 + * The single fallback guard every surface (storefront, checkout, admin) branches
92 + * on: when this returns false, code must fall back to the classic `_subscrpt_*`
93 + * per-product meta and must not read or write any plan table. Keeps plan
94 + * detection consistent so no surface invents its own.
95 + *
96 + * @param int $product_id Product (parent) id.
97 + * @param int $variation_id Variation id, or 0 for simple products.
98 + *
99 + * @return bool
100 + */
101 +function subscrpt_product_has_plan( $product_id, $variation_id = 0 ): bool {
102 + return ! empty(
103 + \SpringDevs\Subscription\Illuminate\Plans\PlanRepository::resolve_for_product( $product_id, $variation_id )
104 + );
105 +}
106 +
107 +/**
108 + * Whether a product / variation is actually offered as a subscription on the
109 + * storefront: it must be tied to a plan AND be subscription-enabled
110 + * (`_subscrpt_enabled`) on the exact entity — the variation when a variation id
111 + * is given, otherwise the product. Storefront surfaces (plan selector, plan
112 + * price, variation visibility) branch on this so a plan-tied but disabled
113 + * product / variation shows no subscription UI at all.
114 + *
115 + * @param int $product_id Product (parent) id.
116 + * @param int $variation_id Variation id, or 0 for simple products.
117 + *
118 + * @return bool
119 + */
120 +function subscrpt_plan_offered( $product_id, $variation_id = 0 ): bool {
121 + if ( ! subscrpt_product_has_plan( $product_id, $variation_id ) ) {
122 + return false;
123 + }
124 +
125 + return subscrpt_is_subscription_enabled( $product_id, $variation_id );
126 +}
127 +
128 +/**
129 + * Whether a product / variation is subscription-enabled (`_subscrpt_enabled`).
130 + *
131 + * When the enable meta was never explicitly saved, a connected plan turns the
132 + * subscription on by default — so attaching a plan enables it automatically, and
133 + * it stays on until a save explicitly clears the toggle (an empty saved value).
134 + * With no plan and no saved meta it is off (a fresh product defaults to off).
135 + *
136 + * @param int $product_id Product (parent) id.
137 + * @param int $variation_id Variation id, or 0 for simple products.
138 + *
139 + * @return bool
140 + */
141 +function subscrpt_is_subscription_enabled( $product_id, $variation_id = 0 ): bool {
142 + $entity_id = $variation_id ? (int) $variation_id : (int) $product_id;
143 +
144 + if ( metadata_exists( 'post', $entity_id, '_subscrpt_enabled' ) ) {
145 + return ! empty( get_post_meta( $entity_id, '_subscrpt_enabled', true ) );
146 + }
147 +
148 + // Never explicitly set: a connected plan enables the subscription by default.
149 + return subscrpt_product_has_plan( $product_id, $variation_id );
150 +}
151 +
152 +/**
153 + * Discount badge text for a storefront plan selector card.
154 + *
155 + * The single source both selectors share, so free and Pro word a discount
156 + * identically. Returning an empty string from the filter hides the badge.
157 + *
158 + * @param array $group Plan group (id, type, label, terms, discount_percent, …).
159 + * @param \WC_Product $product Product or variation being rendered.
160 + * @param int $percent The group's best discount percentage.
161 + * @param bool $varying Whether the group's terms discount by differing
162 + * amounts, in which case the badge reads "up to".
163 + *
164 + * @return string
165 + */
166 +function subscrpt_card_badge_text( $group, $product, $percent = 0, $varying = false ) {
167 + if ( $percent > 0 ) {
168 + $default = $varying
169 + /* translators: %d: discount percentage. */
170 + ? sprintf( __( 'Save up to %d%%', 'subscription' ), $percent )
171 + /* translators: %d: discount percentage. */
172 + : sprintf( __( 'Save %d%%', 'subscription' ), $percent );
173 + } else {
174 + $default = __( 'Sale', 'subscription' );
175 + }
176 +
177 + /**
178 + * Filters the discount badge text on a storefront plan selector card.
179 + *
180 + * @param string $text Badge text (empty string hides the badge).
181 + * @param array $group The plan group (id, type, label, terms, discount_percent, …).
182 + * @param \WC_Product $product Product or variation being rendered.
183 + * @param int $percent Computed discount percentage for the group.
184 + */
185 + return (string) apply_filters( 'subscrpt_plan_card_badge', $default, $group, $product, $percent );
186 +}
187 +
188 +/**
189 + * Build the storefront One-Time Purchase card for a product or variation.
190 + *
191 + * Offered only when the merchant opted in on this exact product or variation:
192 + * `_subscrpt_one_time_enabled` is stored per variation, so pass the variation
193 + * itself, never its parent, whose flag only means "any variation enabled".
194 + *
195 + * The single source of the one-time price maths. Both selectors call it so the
196 + * free and Pro storefronts can never disagree on a price; Pro layers its
197 + * discount badge onto the returned group rather than recomputing anything.
198 + *
199 + * @param \WC_Product $product Product or variation.
200 + *
201 + * @return array|null Selector group in plan-selector.php shape, or null when
202 + * one-time purchase is not offered for this product.
203 + */
204 +function subscrpt_one_time_group( $product ) {
205 + if ( ! $product instanceof \WC_Product || ! function_exists( 'wc_price' ) ) {
206 + return null;
207 + }
208 +
209 + if ( 'yes' !== get_post_meta( $product->get_id(), '_subscrpt_one_time_enabled', true ) ) {
210 + return null;
211 + }
212 +
213 + $regular = (float) $product->get_regular_price();
214 + $sale = $product->get_sale_price();
215 + $price = '' !== $sale ? (float) $sale : $regular;
216 +
217 + // Strike the regular price through only when one-time is genuinely on sale.
218 + $old_price = ( '' !== $sale && (float) $sale < $regular ) ? wc_price( $regular ) : '';
219 + $percent = ( '' !== $old_price && $regular > 0 )
220 + ? (int) round( ( $regular - $price ) / $regular * 100 )
221 + : 0;
222 +
223 + $group = array(
224 + 'id' => 'one_time',
225 + 'type' => 'one_time',
226 + 'label' => __( 'One Time Purchase', 'subscription' ),
227 + 'price' => wc_price( $price ),
228 + 'old_price' => $old_price,
229 + 'terms' => array(),
230 + 'note' => '',
231 + 'badge' => '',
232 + 'discount_percent' => $percent,
233 + );
234 +
235 + if ( $percent > 0 ) {
236 + $group['badge'] = subscrpt_card_badge_text( $group, $product, $percent, false );
237 + }
238 +
239 + return $group;
240 +}
241 +
242 +/**
243 + * Truncate a string to a max length, appending an ellipsis when shortened.
244 + *
245 + * Multibyte-safe. Returns the text unchanged when it is within the limit, so
246 + * callers can compare the result to the original to detect truncation (e.g. to
247 + * add a title attribute with the full text).
248 + *
249 + * @param string $text Text to truncate.
250 + * @param int $length Maximum length before truncation. Default 30.
251 + *
252 + * @return string
253 + */
254 +function subscrpt_truncate_text( $text, $length = 30 ) {
255 + $text = (string) $text;
256 + return mb_strlen( $text ) > $length ? mb_substr( $text, 0, $length ) . '…' : $text;
257 +}
258 +
259 +/**
260 + * Resolve a setting that was renamed without its readers being updated.
261 + *
262 + * Commit d4719e1 ("changed SUBSCRPT to WP_SUBSCRIPTION") renamed six option ids
263 + * inside Admin/Settings.php and touched no reader. Four were caught later; two
264 + * were not, so since 2025-05-08 the settings screen has been writing
265 + * `wp_subscription_*` while the code kept reading `subscrpt_*` — the saved value
266 + * never reached the feature, and the feature's default never reached the screen.
267 + *
268 + * Reading both names is what makes the two agree again. It is deliberately a
269 + * read and not a migration: `subscrpt_is_auto_renew_enabled()` is called from
270 + * the Stripe gateway and the renewal actions, and an option write on that path
271 + * to fix a display problem is a bad trade. A site that saves its settings once
272 + * writes the current name and never consults the legacy one again.
273 + *
274 + * @param string $option Current option name.
275 + * @param string $legacy_option Name used before the rename.
276 + * @param mixed $default_value Value when neither is set.
277 + * @return mixed
278 + */
279 +function subscrpt_get_renamed_option( $option, $legacy_option, $default_value = '' ) {
280 + $value = get_option( $option, '' );
281 +
282 + if ( '' !== $value && false !== $value && null !== $value ) {
283 + return $value;
284 + }
285 +
286 + return get_option( $legacy_option, $default_value );
287 +}
288 +
289 +/**
79 290 * Get renewal process settings.
80 291 *
292 + * Must be used everywhere the renewal process is read, including the settings
293 + * field itself — if the screen resolved the value differently from the code it
294 + * would show "Automatic" to a site that is in fact set to manual.
295 + *
296 + * @return string 'auto' or 'manual'.
297 + */
298 +function subscrpt_get_renewal_process() {
299 + return (string) subscrpt_get_renamed_option( 'wp_subscription_renewal_process', 'subscrpt_renewal_process', 'auto' );
300 +}
301 +
302 +/**
303 + * Notice shown when a manual renewal puts the product in the cart.
304 + *
305 + * @return string
306 + */
307 +function subscrpt_get_manual_renew_cart_notice() {
308 + return (string) subscrpt_get_renamed_option( 'wp_subscription_manual_renew_cart_notice', 'subscrpt_manual_renew_cart_notice', '' );
309 +}
310 +
311 +/**
312 + * Get renewal process settings.
313 + *
81 314 * @return bool
82 315 */
83 316 function subscrpt_is_auto_renew_enabled() {
84 - return 'auto' === get_option( 'subscrpt_renewal_process', 'auto' );
317 + return 'auto' === subscrpt_get_renewal_process();
85 318 }
86 319
87 320 /**
321 + * Split-payment amounts for a given total and installment count.
322 + *
323 + * Single source of truth for split math so the product page, cart, checkout and
324 + * subscription always agree:
325 + * - per_installment = total / count, rounded UP to 2 decimals (ceil)
326 + * - total = the price exactly as entered (never per × count)
327 + *
328 + * @param float|string $total Total price as entered on the plan/product.
329 + * @param int $count Number of installments (minimum 1).
330 + * @return array{total:float,count:int,per_installment:float}
331 + */
332 +function subscrpt_split_amounts( $total, $count ) {
333 + $total = (float) $total;
334 + $count = max( 1, (int) $count );
335 +
336 + return array(
337 + 'total' => $total,
338 + 'count' => $count,
339 + 'per_installment' => ceil( $total / $count * 100 ) / 100,
340 + );
341 +}
342 +
343 +/**
88 344 * Get maximum payments for a subscription, checking variation, product, and subscription meta.
89 345 *
90 346 * @param int $subscription_id Subscription ID.
91 347 * @return string|int Maximum payments or empty string if not set.
@@ -113,9 +369,9 @@
113 369 if ( ! $max_payments ) {
114 370 $max_payments = get_post_meta( $subscription_id, '_subscrpt_max_no_payment', true );
115 371 }
116 372
117 - return $max_payments ?: '';
373 + return $max_payments ? $max_payments : '';
118 374 }
119 375
120 376 /**
121 377 * Count total payments made.
@@ -127,16 +383,14 @@
127 383 global $wpdb;
128 384
129 385 $table_name = $wpdb->prefix . 'subscrpt_order_relation';
130 386
387 + // Query the relation table only. Joining wp_posts would drop every row under
388 + // HPOS (orders are not stored there); wc_get_order() below is HPOS-safe.
131 389 // phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
132 390 $relations = $wpdb->get_results(
133 391 $wpdb->prepare(
134 - "SELECT sr.*, p.post_status, p.post_date
135 - FROM $table_name sr
136 - INNER JOIN {$wpdb->posts} p ON sr.order_id = p.ID
137 - WHERE sr.subscription_id = %d
138 - ORDER BY p.post_date ASC",
392 + "SELECT * FROM $table_name WHERE subscription_id = %d ORDER BY id ASC",
139 393 $subscription_id
140 394 )
141 395 );
142 396 // phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
@@ -194,14 +448,11 @@
194 448 $is_reached = subscrpt_check_enhanced_completion( $subscription_id, $payments_made, $max_payments );
195 449
196 450 // Fire action when split payment plan is completed (first time only)
197 451 if ( $is_reached && ! get_post_meta( $subscription_id, '_subscrpt_split_payment_completed_fired', true ) ) {
198 - // Add completion milestone note
199 - subscrpt_add_payment_completion_note( $subscription_id, $payments_made, $max_payments );
452 + // All installments paid: complete the subscription (no renewal / expiry / grace).
453 + $expire_status = apply_filters( 'subscrpt_split_payment_expire_status', 'completed', $subscription_id, $payments_made, $max_payments );
200 454
201 - // Allow customization of subscription status after completion
202 - $expire_status = apply_filters( 'subscrpt_split_payment_expire_status', 'expired', $subscription_id, $payments_made, $max_payments );
203 -
204 455 // Update subscription status if different from current
205 456 $current_status = get_post_status( $subscription_id );
206 457 if ( $current_status !== $expire_status ) {
207 458 wp_update_post(
@@ -211,8 +462,11 @@
211 462 )
212 463 );
213 464 }
214 465
466 + // Clear the next date so cron never expires it into a grace period.
467 + delete_post_meta( $subscription_id, '_subscrpt_next_date' );
468 +
215 469 do_action( 'subscrpt_split_payment_completed', $subscription_id, $payments_made, $max_payments );
216 470 update_post_meta( $subscription_id, '_subscrpt_split_payment_completed_fired', true );
217 471
218 472 // Handle split payment access timing if Pro version is active
@@ -289,8 +543,44 @@
289 543 return $payment_type;
290 544 }
291 545
292 546 /**
547 + * Human-readable label of the plan a subscription was purchased on.
548 + *
549 + * Combines the plan group name and the plan-term title (e.g. "Split Pay – Every
550 + * Day"). Returns an empty string for legacy per-product subscriptions that were
551 + * not bought through a plan.
552 + *
553 + * @param int $subscription_id Subscription ID.
554 + * @return string Plan label, or '' when the subscription has no plan.
555 + */
556 +function subscrpt_get_subscription_plan_label( $subscription_id ) {
557 + $plan_id = (int) get_post_meta( $subscription_id, '_subscrpt_plan_id', true );
558 + if ( ! $plan_id || ! class_exists( '\SpringDevs\Subscription\Illuminate\Plans\PlanRepository' ) ) {
559 + return '';
560 + }
561 +
562 + $plan = \SpringDevs\Subscription\Illuminate\Plans\PlanRepository::get_plan( $plan_id );
563 + if ( ! $plan ) {
564 + return '';
565 + }
566 +
567 + $term_title = isset( $plan['title'] ) ? trim( (string) $plan['title'] ) : '';
568 + $group_title = '';
569 + $group_id = (int) ( $plan['plan_group_id'] ?? 0 );
570 + if ( $group_id ) {
571 + $group = \SpringDevs\Subscription\Illuminate\Plans\PlanRepository::get_group( $group_id );
572 + if ( $group && isset( $group['title'] ) ) {
573 + $group_title = trim( (string) $group['title'] );
574 + }
575 + }
576 +
577 + $parts = array_filter( array( $group_title, $term_title ) );
578 +
579 + return implode( ' – ', $parts );
580 +}
581 +
582 +/**
293 583 * Enhanced completion check considering failed payments and access suspension.
294 584 *
295 585 * @param int $subscription_id Subscription ID.
296 586 * @param int $payments_made Number of successful payments made.
@@ -315,9 +605,9 @@
315 605 }
316 606 }
317 607
318 608 // Check for maximum failure threshold
319 - $failure_count = get_post_meta( $subscription_id, '_subscrpt_payment_failure_count', true ) ?: 0;
609 + $failure_count = (int) get_post_meta( $subscription_id, '_subscrpt_payment_failure_count', true );
320 610 $max_failures_before_completion = apply_filters( 'subscrpt_max_failures_before_completion', 0, $subscription_id );
321 611
322 612 if ( $max_failures_before_completion > 0 && $failure_count >= $max_failures_before_completion ) {
323 613 // Force completion after too many failures
@@ -349,16 +639,14 @@
349 639 global $wpdb;
350 640
351 641 $table_name = $wpdb->prefix . 'subscrpt_order_relation';
352 642
643 + // Query the relation table only. Joining wp_posts would drop every row under
644 + // HPOS (orders are not stored there); wc_get_order() below is HPOS-safe.
353 645 // phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
354 646 $relations = $wpdb->get_results(
355 647 $wpdb->prepare(
356 - "SELECT sr.*, p.post_status, p.post_date
357 - FROM $table_name sr
358 - INNER JOIN {$wpdb->posts} p ON sr.order_id = p.ID
359 - WHERE sr.subscription_id = %d
360 - ORDER BY p.post_date ASC",
648 + "SELECT * FROM $table_name WHERE subscription_id = %d ORDER BY id ASC",
361 649 $subscription_id
362 650 )
363 651 );
364 652 // phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
@@ -548,8 +836,11 @@
548 836 /**
549 837 * Get WC product in subscription wrapper.
550 838 *
551 839 * @deprecated 1.8.17 Use SpringDevs\Subscription\Illuminate\Subscription\Subscription::get_subs_product().
840 + *
841 + * @param \WC_Product|int $product Product object or product id.
842 + * @return mixed Subscription product wrapper.
552 843 */
553 844 function sdevs_get_subscription_product( $product ) {
554 845 // Deprecated notice.
555 846 _deprecated_function( 'sdevs_get_subscription_product', '1.8.17', 'SpringDevs\Subscription\Illuminate\Subscription\Subscription::get_subs_product' );
@@ -584,64 +875,5 @@
584 875 } else {
585 876 error_log( 'wp_subscription: ' . $log ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions
586 877 }
587 878 }
588 -}
589 -
590 -/**
591 - * Add payment completion note for split payment subscriptions.
592 - *
593 - * @param int $subscription_id Subscription ID.
594 - * @param int $payments_made Number of payments made.
595 - * @param int $max_payments Maximum number of payments.
596 - */
597 -function subscrpt_add_payment_completion_note( $subscription_id, $payments_made, $max_payments ) {
598 - // Check if this is a split payment subscription
599 - if ( ! function_exists( 'subscrpt_get_payment_type' ) ) {
600 - return;
601 - }
602 -
603 - $payment_type = subscrpt_get_payment_type( $subscription_id );
604 - if ( 'split_payment' !== $payment_type ) {
605 - return;
606 - }
607 -
608 - // Create completion note
609 - $completion_note = sprintf(
610 - /* translators: %1$d: payments made, %2$d: total payments */
611 - __( 'Split payment plan completed successfully! %1$d of %2$d payments received.', 'subscription' ),
612 - $payments_made,
613 - $max_payments
614 - );
615 -
616 - // Add the completion note
617 - $comment_id = wp_insert_comment(
618 - array(
619 - 'comment_author' => 'Subscription for WooCommerce',
620 - 'comment_content' => $completion_note,
621 - 'comment_post_ID' => $subscription_id,
622 - 'comment_type' => 'order_note',
623 - )
624 - );
625 - update_comment_meta( $comment_id, '_subscrpt_activity', __( 'Split Payment - Plan Complete', 'subscription' ) );
626 - update_comment_meta( $comment_id, '_subscrpt_activity_type', 'split_payment' );
627 -
628 - // Add payment summary note
629 - $payment_summary = sprintf(
630 - /* translators: %1$d: payments made, %2$d: total payments, %3$s: completion date */
631 - __( 'Payment Summary: %1$d of %2$d installments completed on %3$s. All payments received successfully.', 'subscription' ),
632 - $payments_made,
633 - $max_payments,
634 - date_i18n( wc_date_format(), current_time( 'timestamp' ) )
635 - );
636 -
637 - $summary_comment_id = wp_insert_comment(
638 - array(
639 - 'comment_author' => 'Subscription for WooCommerce',
640 - 'comment_content' => $payment_summary,
641 - 'comment_post_ID' => $subscription_id,
642 - 'comment_type' => 'order_note',
643 - )
644 - );
645 - update_comment_meta( $summary_comment_id, '_subscrpt_activity', __( 'Payment Summary - Complete', 'subscription' ) );
646 - update_comment_meta( $summary_comment_id, '_subscrpt_activity_type', 'split_payment_summary' );
647 879 }