mirror of
https://github.com/pronamic/woocommerce-subscriptions.git
synced 2025-10-17 14:52:56 +00:00
1201 lines
49 KiB
PHP
1201 lines
49 KiB
PHP
<?php
|
|
/**
|
|
* Individual Subscription Product API
|
|
*
|
|
* An API for accessing details of a subscription product.
|
|
*
|
|
* @package WooCommerce Subscriptions
|
|
* @subpackage WC_Subscriptions_Product
|
|
* @category Class
|
|
* @author Brent Shepherd
|
|
* @since 1.0
|
|
*/
|
|
class WC_Subscriptions_Product {
|
|
|
|
/* cache the check on whether the session has an order awaiting payment for a given product */
|
|
protected static $order_awaiting_payment_for_product = array();
|
|
|
|
protected static $subscription_meta_fields = array(
|
|
'_subscription_price',
|
|
'_subscription_sign_up_fee',
|
|
'_subscription_period',
|
|
'_subscription_period_interval',
|
|
'_subscription_length',
|
|
'_subscription_trial_period',
|
|
'_subscription_trial_length',
|
|
);
|
|
|
|
/**
|
|
* Set up the class, including it's hooks & filters, when the file is loaded.
|
|
*
|
|
* @since 1.0
|
|
**/
|
|
public static function init() {
|
|
|
|
// Because the standard price meta field is empty, we need to output our custom subscription description
|
|
add_filter( 'woocommerce_grouped_price_html', __CLASS__ . '::get_grouped_price_html', 10, 2 );
|
|
|
|
// Gravity Forms Add-ons
|
|
add_filter( 'woocommerce_gform_base_price', __CLASS__ . '::get_gravity_form_prices', 10, 2 );
|
|
add_filter( 'woocommerce_gform_total_price', __CLASS__ . '::get_gravity_form_prices', 10, 2 );
|
|
add_filter( 'woocommerce_gform_variation_total_price', __CLASS__ . '::get_gravity_form_prices', 10, 2 );
|
|
|
|
add_filter( 'woocommerce_product_class', __CLASS__ . '::set_subscription_variation_class', 10, 4 );
|
|
|
|
// Make sure a subscriptions price is included in subscription variations when required
|
|
add_filter( 'woocommerce_available_variation', __CLASS__ . '::maybe_set_variations_price_html', 10, 3 );
|
|
|
|
// Sync variable product min/max prices with WC 3.0
|
|
add_action( 'woocommerce_variable_product_sync_data', __CLASS__ . '::variable_subscription_product_sync', 10 );
|
|
|
|
// Prevent users from deleting subscription products - it causes too many problems with WooCommerce and other plugins
|
|
add_filter( 'user_has_cap', __CLASS__ . '::user_can_not_delete_subscription', 10, 3 );
|
|
|
|
// Make sure subscription products in the trash can be restored
|
|
add_filter( 'post_row_actions', __CLASS__ . '::subscription_row_actions', 10, 2 );
|
|
|
|
// Remove the "Delete Permanently" bulk action on the Edit Products screen
|
|
add_filter( 'bulk_actions-edit-product', __CLASS__ . '::subscription_bulk_actions', 10 );
|
|
|
|
// Do not allow subscription products to be automatically purged on the 'wp_scheduled_delete' hook
|
|
add_action( 'wp_scheduled_delete', __CLASS__ . '::prevent_scheduled_deletion', 9 );
|
|
|
|
// Trash variations instead of deleting them to prevent headaches from deleted products
|
|
add_action( 'wp_ajax_woocommerce_remove_variation', __CLASS__ . '::remove_variations', 9, 2 );
|
|
add_action( 'wp_ajax_woocommerce_remove_variations', __CLASS__ . '::remove_variations', 9, 2 );
|
|
|
|
// Handle bulk edits to subscription data in WC 2.4
|
|
add_action( 'woocommerce_bulk_edit_variations', __CLASS__ . '::bulk_edit_variations', 10, 4 );
|
|
|
|
// Adds a field flagging whether the variation is safe to be removed or not.
|
|
add_action( 'woocommerce_product_after_variable_attributes', array( __CLASS__, 'add_variation_removal_flag' ), 10, 3 );
|
|
|
|
// check product variations for sync'd or trial
|
|
add_action( 'wp_ajax_wcs_product_has_trial_or_is_synced', __CLASS__ . '::check_product_variations_for_syncd_or_trial' );
|
|
|
|
// maybe update the One Time Shipping product setting when users edit variations using bulk actions and the variation level save
|
|
add_action( 'wp_ajax_wcs_update_one_time_shipping', __CLASS__ . '::maybe_update_one_time_shipping_on_variation_edits' );
|
|
}
|
|
|
|
/**
|
|
* Returns the raw sign up fee value (ignoring tax) by filtering the products price.
|
|
*
|
|
* @return string
|
|
*/
|
|
public static function get_sign_up_fee_filter( $price, $product ) {
|
|
|
|
return self::get_sign_up_fee( $product );
|
|
}
|
|
|
|
/**
|
|
* Override the WooCommerce "Add to Cart" text with "Sign Up Now".
|
|
*
|
|
* @since 1.0
|
|
*/
|
|
public static function add_to_cart_text( $button_text, $product_type = '' ) {
|
|
global $product;
|
|
|
|
if ( self::is_subscription( $product ) || in_array( $product_type, array( 'subscription', 'subscription-variation' ) ) ) {
|
|
$button_text = get_option( WC_Subscriptions_Admin::$option_prefix . '_add_to_cart_button_text', __( 'Sign Up Now', 'woocommerce-subscriptions' ) );
|
|
}
|
|
|
|
return $button_text;
|
|
}
|
|
|
|
/**
|
|
* Checks a given product to determine if it is a subscription.
|
|
* When the received arg is a product object, make sure it is passed into the filter intact in order to retain any properties added on the fly.
|
|
*
|
|
* @param int|WC_Product $product Either a product object or product's post ID.
|
|
* @since 1.0
|
|
*/
|
|
public static function is_subscription( $product ) {
|
|
|
|
$is_subscription = $product_id = false;
|
|
|
|
$product = self::maybe_get_product_instance( $product );
|
|
|
|
if ( is_object( $product ) ) {
|
|
|
|
$product_id = $product->get_id();
|
|
|
|
if ( $product->is_type( array( 'subscription', 'subscription_variation', 'variable-subscription' ) ) ) {
|
|
$is_subscription = true;
|
|
}
|
|
}
|
|
|
|
return apply_filters( 'woocommerce_is_subscription', $is_subscription, $product_id, $product );
|
|
}
|
|
|
|
/**
|
|
* Output subscription string as the price html for grouped products and make sure that
|
|
* sign-up fees are taken into account for price.
|
|
*
|
|
* @since 1.3.4
|
|
*/
|
|
public static function get_grouped_price_html( $price, $grouped_product ) {
|
|
|
|
$child_prices = array();
|
|
$contains_subscription = false;
|
|
|
|
foreach ( $grouped_product->get_children() as $child_product_id ) {
|
|
|
|
if ( self::is_subscription( $child_product_id ) ) {
|
|
|
|
$contains_subscription = true;
|
|
|
|
$child_product = wc_get_product( $child_product_id );
|
|
|
|
$tax_display_mode = get_option( 'woocommerce_tax_display_shop' );
|
|
$child_price = 'incl' == $tax_display_mode ? wcs_get_price_including_tax( $child_product, array( 'price' => $child_product->get_price() ) ) : wcs_get_price_excluding_tax( $child_product, array( 'price' => $child_product->get_price() ) );
|
|
$sign_up_fee = 'incl' == $tax_display_mode ? wcs_get_price_including_tax( $child_product, array( 'price' => self::get_sign_up_fee( $child_product ) ) ) : wcs_get_price_excluding_tax( $child_product, array( 'price' => self::get_sign_up_fee( $child_product ) ) );
|
|
$has_trial = ( self::get_trial_length( $child_product ) > 0 ) ? true : false;
|
|
|
|
// Make sure we have the *real* price (i.e. total initial payment)
|
|
if ( $has_trial && $sign_up_fee > 0 ) {
|
|
$child_price = $sign_up_fee;
|
|
} else {
|
|
$child_price += $sign_up_fee;
|
|
}
|
|
|
|
$child_prices[] = $child_price;
|
|
|
|
} else {
|
|
|
|
$child_prices[] = get_post_meta( $child_product_id, '_price', true );
|
|
|
|
}
|
|
}
|
|
|
|
if ( ! $contains_subscription ) {
|
|
return $price;
|
|
} else {
|
|
$price = '';
|
|
}
|
|
|
|
$child_prices = array_unique( $child_prices );
|
|
|
|
if ( ! empty( $child_prices ) ) {
|
|
$min_price = min( $child_prices );
|
|
} else {
|
|
$min_price = '';
|
|
}
|
|
|
|
if ( sizeof( $child_prices ) > 1 ) {
|
|
$price .= wcs_get_price_html_from_text( $grouped_product );
|
|
}
|
|
|
|
$price .= wc_price( $min_price );
|
|
|
|
return $price;
|
|
}
|
|
|
|
/**
|
|
* Output subscription string in Gravity Form fields.
|
|
*
|
|
* @since 1.1
|
|
*/
|
|
public static function get_gravity_form_prices( $price, $product ) {
|
|
|
|
if ( self::is_subscription( $product ) ) {
|
|
$price = self::get_price_string( $product, array( 'price' => $price, 'subscription_length' => false, 'sign_up_fee' => false, 'trial_length' => false ) );
|
|
}
|
|
|
|
return $price;
|
|
}
|
|
|
|
/**
|
|
* Returns a string representing the details of the subscription.
|
|
*
|
|
* For example "$20 per Month for 3 Months with a $10 sign-up fee".
|
|
*
|
|
* @param WC_Product|int $product A WC_Product object or ID of a WC_Product.
|
|
* @param array $inclusions An associative array of flags to indicate how to calculate the price and what to include, values:
|
|
* 'tax_calculation' => false to ignore tax, 'include_tax' or 'exclude_tax' To indicate that tax should be added or excluded respectively
|
|
* 'subscription_length' => true to include subscription's length (default) or false to exclude it
|
|
* 'sign_up_fee' => true to include subscription's sign up fee (default) or false to exclude it
|
|
* 'price' => string a price to short-circuit the price calculations and use in a string for the product
|
|
* @since 1.0
|
|
*/
|
|
public static function get_price_string( $product, $include = array() ) {
|
|
global $wp_locale;
|
|
|
|
$product = self::maybe_get_product_instance( $product );
|
|
|
|
if ( ! self::is_subscription( $product ) ) {
|
|
return;
|
|
}
|
|
|
|
$include = wp_parse_args( $include, array(
|
|
'tax_calculation' => get_option( 'woocommerce_tax_display_shop' ),
|
|
'subscription_price' => true,
|
|
'subscription_period' => true,
|
|
'subscription_length' => true,
|
|
'sign_up_fee' => true,
|
|
'trial_length' => true,
|
|
)
|
|
);
|
|
|
|
$include = apply_filters( 'woocommerce_subscriptions_product_price_string_inclusions', $include, $product );
|
|
|
|
$base_price = self::get_price( $product );
|
|
|
|
if ( true === $include['sign_up_fee'] ) {
|
|
$sign_up_fee = self::get_sign_up_fee( $product );
|
|
} elseif ( false !== $include['sign_up_fee'] ) { // Allow override of product's sign-up fee
|
|
$sign_up_fee = $include['sign_up_fee'];
|
|
} else {
|
|
$sign_up_fee = 0;
|
|
}
|
|
|
|
if ( false != $include['tax_calculation'] ) {
|
|
|
|
if ( in_array( $include['tax_calculation'], array( 'exclude_tax', 'excl' ) ) ) { // Subtract Tax
|
|
|
|
if ( isset( $include['price'] ) ) {
|
|
$price = $include['price'];
|
|
} else {
|
|
$price = wcs_get_price_excluding_tax( $product );
|
|
}
|
|
|
|
if ( true === $include['sign_up_fee'] ) {
|
|
$sign_up_fee = wcs_get_price_excluding_tax( $product, array( 'price' => WC_Subscriptions_Product::get_sign_up_fee( $product ) ) );
|
|
}
|
|
} else { // Add Tax
|
|
|
|
if ( isset( $include['price'] ) ) {
|
|
$price = $include['price'];
|
|
} else {
|
|
$price = wcs_get_price_including_tax( $product );
|
|
}
|
|
|
|
if ( true === $include['sign_up_fee'] ) {
|
|
$sign_up_fee = wcs_get_price_including_tax( $product, array( 'price' => WC_Subscriptions_Product::get_sign_up_fee( $product ) ) );
|
|
}
|
|
}
|
|
} else {
|
|
|
|
if ( isset( $include['price'] ) ) {
|
|
$price = $include['price'];
|
|
} else {
|
|
$price = wc_price( $base_price );
|
|
}
|
|
}
|
|
|
|
$price .= ' <span class="subscription-details">';
|
|
|
|
$billing_interval = self::get_interval( $product );
|
|
$billing_period = self::get_period( $product );
|
|
$subscription_length = self::get_length( $product );
|
|
$trial_length = self::get_trial_length( $product );
|
|
$trial_period = self::get_trial_period( $product );
|
|
|
|
if ( is_numeric( $sign_up_fee ) ) {
|
|
$sign_up_fee = wc_price( $sign_up_fee );
|
|
}
|
|
|
|
if ( $include['subscription_length'] ) {
|
|
$ranges = wcs_get_subscription_ranges( $billing_period );
|
|
}
|
|
|
|
if ( $include['subscription_length'] && 0 != $subscription_length ) {
|
|
$include_length = true;
|
|
} else {
|
|
$include_length = false;
|
|
}
|
|
|
|
$subscription_string = '';
|
|
|
|
if ( $include['subscription_price'] && $include['subscription_period'] ) { // Allow extensions to not show price or billing period e.g. Name Your Price
|
|
if ( $include_length && $subscription_length == $billing_interval ) {
|
|
$subscription_string = $price; // Only for one billing period so show "$5 for 3 months" instead of "$5 every 3 months for 3 months"
|
|
} elseif ( WC_Subscriptions_Synchroniser::is_product_synced( $product ) && in_array( $billing_period, array( 'week', 'month', 'year' ) ) ) {
|
|
$payment_day = WC_Subscriptions_Synchroniser::get_products_payment_day( $product );
|
|
switch ( $billing_period ) {
|
|
case 'week':
|
|
$payment_day_of_week = WC_Subscriptions_Synchroniser::get_weekday( $payment_day );
|
|
if ( 1 == $billing_interval ) {
|
|
// translators: 1$: recurring amount string, 2$: day of the week (e.g. "$10 every Wednesday")
|
|
$subscription_string = sprintf( __( '%1$s every %2$s', 'woocommerce-subscriptions' ), $price, $payment_day_of_week );
|
|
} else {
|
|
// translators: 1$: recurring amount string, 2$: period, 3$: day of the week (e.g. "$10 every 2nd week on Wednesday")
|
|
$subscription_string = sprintf( __( '%1$s every %2$s on %3$s', 'woocommerce-subscriptions' ), $price, wcs_get_subscription_period_strings( $billing_interval, $billing_period ), $payment_day_of_week );
|
|
}
|
|
break;
|
|
case 'month':
|
|
if ( 1 == $billing_interval ) {
|
|
if ( $payment_day > 27 ) {
|
|
// translators: placeholder is recurring amount
|
|
$subscription_string = sprintf( __( '%s on the last day of each month', 'woocommerce-subscriptions' ), $price );
|
|
} else {
|
|
// translators: 1$: recurring amount, 2$: day of the month (e.g. "23rd") (e.g. "$5 every 23rd of each month")
|
|
$subscription_string = sprintf( __( '%1$s on the %2$s of each month', 'woocommerce-subscriptions' ), $price, WC_Subscriptions::append_numeral_suffix( $payment_day ) );
|
|
}
|
|
} else {
|
|
if ( $payment_day > 27 ) {
|
|
// translators: 1$: recurring amount, 2$: interval (e.g. "3rd") (e.g. "$10 on the last day of every 3rd month")
|
|
$subscription_string = sprintf( __( '%1$s on the last day of every %2$s month', 'woocommerce-subscriptions' ), $price, WC_Subscriptions::append_numeral_suffix( $billing_interval ) );
|
|
} else {
|
|
// translators: 1$: <price> on the, 2$: <date> day of every, 3$: <interval> month (e.g. "$10 on the 23rd day of every 2nd month")
|
|
$subscription_string = sprintf( __( '%1$s on the %2$s day of every %3$s month', 'woocommerce-subscriptions' ), $price, WC_Subscriptions::append_numeral_suffix( $payment_day ), WC_Subscriptions::append_numeral_suffix( $billing_interval ) );
|
|
}
|
|
}
|
|
break;
|
|
case 'year':
|
|
if ( 1 == $billing_interval ) {
|
|
// translators: 1$: <price> on, 2$: <date>, 3$: <month> each year (e.g. "$15 on March 15th each year")
|
|
$subscription_string = sprintf( __( '%1$s on %2$s %3$s each year', 'woocommerce-subscriptions' ), $price, $wp_locale->month[ $payment_day['month'] ], WC_Subscriptions::append_numeral_suffix( $payment_day['day'] ) );
|
|
} else {
|
|
// translators: 1$: recurring amount, 2$: month (e.g. "March"), 3$: day of the month (e.g. "23rd") (e.g. "$15 on March 15th every 3rd year")
|
|
$subscription_string = sprintf( __( '%1$s on %2$s %3$s every %4$s year', 'woocommerce-subscriptions' ), $price, $wp_locale->month[ $payment_day['month'] ], WC_Subscriptions::append_numeral_suffix( $payment_day['day'] ), WC_Subscriptions::append_numeral_suffix( $billing_interval ) );
|
|
}
|
|
break;
|
|
}
|
|
} else {
|
|
// translators: 1$: recurring amount, 2$: subscription period (e.g. "month" or "3 months") (e.g. "$15 / month" or "$15 every 2nd month")
|
|
$subscription_string = sprintf( _n( '%1$s / %2$s', ' %1$s every %2$s', $billing_interval, 'woocommerce-subscriptions' ), $price, wcs_get_subscription_period_strings( $billing_interval, $billing_period ) );
|
|
}
|
|
} elseif ( $include['subscription_price'] ) {
|
|
$subscription_string = $price;
|
|
} elseif ( $include['subscription_period'] ) {
|
|
// translators: billing period (e.g. "every week")
|
|
$subscription_string = '<span class="subscription-details">' . sprintf( __( 'every %s', 'woocommerce-subscriptions' ), wcs_get_subscription_period_strings( $billing_interval, $billing_period ) );
|
|
} else {
|
|
$subscription_string = '<span class="subscription-details">';
|
|
}
|
|
|
|
// Add the length to the end
|
|
if ( $include_length ) {
|
|
// translators: 1$: subscription string (e.g. "$10 up front then $5 on March 23rd every 3rd year"), 2$: length (e.g. "4 years")
|
|
$subscription_string = sprintf( __( '%1$s for %2$s', 'woocommerce-subscriptions' ), $subscription_string, $ranges[ $subscription_length ] );
|
|
}
|
|
|
|
if ( $include['trial_length'] && 0 != $trial_length ) {
|
|
$trial_string = wcs_get_subscription_trial_period_strings( $trial_length, $trial_period );
|
|
// translators: 1$: subscription string (e.g. "$15 on March 15th every 3 years for 6 years"), 2$: trial length (e.g.: "with 4 months free trial")
|
|
$subscription_string = sprintf( __( '%1$s with %2$s free trial', 'woocommerce-subscriptions' ), $subscription_string, $trial_string );
|
|
}
|
|
|
|
if ( $include['sign_up_fee'] && self::get_sign_up_fee( $product ) > 0 ) {
|
|
// translators: 1$: subscription string (e.g. "$15 on March 15th every 3 years for 6 years with 2 months free trial"), 2$: signup fee price (e.g. "and a $30 sign-up fee")
|
|
$subscription_string = sprintf( __( '%1$s and a %2$s sign-up fee', 'woocommerce-subscriptions' ), $subscription_string, $sign_up_fee );
|
|
}
|
|
|
|
$subscription_string .= '</span>';
|
|
|
|
return apply_filters( 'woocommerce_subscriptions_product_price_string', $subscription_string, $product, $include );
|
|
}
|
|
|
|
/**
|
|
* Returns the active price per period for a product if it is a subscription.
|
|
*
|
|
* @param mixed $product A WC_Product object or product ID
|
|
* @return float The price charged per period for the subscription, or an empty string if the product is not a subscription.
|
|
* @since 1.0
|
|
*/
|
|
public static function get_price( $product ) {
|
|
|
|
$product = self::maybe_get_product_instance( $product );
|
|
|
|
$subscription_price = self::get_meta_data( $product, 'subscription_price', 0 );
|
|
$sale_price = self::get_sale_price( $product );
|
|
$active_price = ( $subscription_price ) ? $subscription_price : self::get_regular_price( $product );
|
|
|
|
if ( $product->is_on_sale() && $subscription_price > $sale_price ) {
|
|
$active_price = $sale_price;
|
|
}
|
|
|
|
return apply_filters( 'woocommerce_subscriptions_product_price', $active_price, $product );
|
|
}
|
|
|
|
/**
|
|
* Returns the sale price per period for a product if it is a subscription.
|
|
*
|
|
* @param mixed $product A WC_Product object or product ID
|
|
* @return float
|
|
* @since 2.2.0
|
|
*/
|
|
public static function get_regular_price( $product, $context = 'view' ) {
|
|
|
|
if ( WC_Subscriptions::is_woocommerce_pre( '3.0' ) ) {
|
|
$regular_price = $product->regular_price;
|
|
} else {
|
|
$regular_price = $product->get_regular_price( $context );
|
|
}
|
|
|
|
return apply_filters( 'woocommerce_subscriptions_product_regular_price', $regular_price, $product );
|
|
}
|
|
|
|
/**
|
|
* Returns the regular price per period for a product if it is a subscription.
|
|
*
|
|
* @param mixed $product A WC_Product object or product ID
|
|
* @return float
|
|
* @since 2.2.0
|
|
*/
|
|
public static function get_sale_price( $product, $context = 'view' ) {
|
|
|
|
if ( WC_Subscriptions::is_woocommerce_pre( '3.0' ) ) {
|
|
$sale_price = $product->sale_price;
|
|
} else {
|
|
$sale_price = $product->get_sale_price( $context );
|
|
}
|
|
|
|
return apply_filters( 'woocommerce_subscriptions_product_sale_price', $sale_price, $product );
|
|
}
|
|
|
|
/**
|
|
* Returns the subscription period for a product, if it's a subscription.
|
|
*
|
|
* @param mixed $product A WC_Product object or product ID
|
|
* @return string A string representation of the period, either Day, Week, Month or Year, or an empty string if product is not a subscription.
|
|
* @since 1.0
|
|
*/
|
|
public static function get_period( $product ) {
|
|
return apply_filters( 'woocommerce_subscriptions_product_period', self::get_meta_data( $product, 'subscription_period', '' ), self::maybe_get_product_instance( $product ) );
|
|
}
|
|
|
|
/**
|
|
* Returns the subscription interval for a product, if it's a subscription.
|
|
*
|
|
* @param mixed $product A WC_Product object or product ID
|
|
* @return int An integer representing the subscription interval, or 1 if the product is not a subscription or there is no interval
|
|
* @since 1.0
|
|
*/
|
|
public static function get_interval( $product ) {
|
|
return apply_filters( 'woocommerce_subscriptions_product_period_interval', self::get_meta_data( $product, 'subscription_period_interval', 1, 'use_default_value' ), self::maybe_get_product_instance( $product ) );
|
|
}
|
|
|
|
/**
|
|
* Returns the length of a subscription product, if it is a subscription.
|
|
*
|
|
* @param mixed $product A WC_Product object or product ID
|
|
* @return int An integer representing the length of the subscription, or 0 if the product is not a subscription or the subscription continues for perpetuity
|
|
* @since 1.0
|
|
*/
|
|
public static function get_length( $product ) {
|
|
return apply_filters( 'woocommerce_subscriptions_product_length', self::get_meta_data( $product, 'subscription_length', 0, 'use_default_value' ), self::maybe_get_product_instance( $product ) );
|
|
}
|
|
|
|
/**
|
|
* Returns the trial length of a subscription product, if it is a subscription.
|
|
*
|
|
* @param mixed $product A WC_Product object or product ID
|
|
* @return int An integer representing the length of the subscription trial, or 0 if the product is not a subscription or there is no trial
|
|
* @since 1.0
|
|
*/
|
|
public static function get_trial_length( $product ) {
|
|
return apply_filters( 'woocommerce_subscriptions_product_trial_length', self::get_meta_data( $product, 'subscription_trial_length', 0, 'use_default_value' ), self::maybe_get_product_instance( $product ) );
|
|
}
|
|
|
|
/**
|
|
* Returns the trial period of a subscription product, if it is a subscription.
|
|
*
|
|
* @param mixed $product A WC_Product object or product ID
|
|
* @return string A string representation of the period, either Day, Week, Month or Year, or an empty string if product is not a subscription or there is no trial
|
|
* @since 1.2
|
|
*/
|
|
public static function get_trial_period( $product ) {
|
|
return apply_filters( 'woocommerce_subscriptions_product_trial_period', self::get_meta_data( $product, 'subscription_trial_period', '' ), self::maybe_get_product_instance( $product ) );
|
|
}
|
|
|
|
/**
|
|
* Returns the sign-up fee for a subscription, if it is a subscription.
|
|
*
|
|
* @param mixed $product A WC_Product object or product ID
|
|
* @return float The value of the sign-up fee, or 0 if the product is not a subscription or the subscription has no sign-up fee
|
|
* @since 1.0
|
|
*/
|
|
public static function get_sign_up_fee( $product ) {
|
|
return apply_filters( 'woocommerce_subscriptions_product_sign_up_fee', self::get_meta_data( $product, 'subscription_sign_up_fee', 0, 'use_default_value' ), self::maybe_get_product_instance( $product ) );
|
|
}
|
|
|
|
/**
|
|
* Takes a subscription product's ID and returns the date on which the first renewal payment will be processed
|
|
* based on the subscription's length and calculated from either the $from_date if specified, or the current date/time.
|
|
*
|
|
* @param int $product_id The product/post ID of a subscription product
|
|
* @param mixed $from_date A MySQL formatted date/time string from which to calculate the expiration date, or empty (default), which will use today's date/time.
|
|
* @param string $type The return format for the date, either 'mysql', or 'timezone'. Default 'mysql'.
|
|
* @param string $timezone The timezone for the returned date, either 'site' for the site's timezone, or 'gmt'. Default, 'site'.
|
|
* @since 2.0
|
|
*/
|
|
public static function get_first_renewal_payment_date( $product_id, $from_date = '', $timezone = 'gmt' ) {
|
|
|
|
$first_renewal_timestamp = self::get_first_renewal_payment_time( $product_id, $from_date, $timezone );
|
|
|
|
if ( $first_renewal_timestamp > 0 ) {
|
|
$first_renewal_date = gmdate( 'Y-m-d H:i:s', $first_renewal_timestamp );
|
|
} else {
|
|
$first_renewal_date = 0;
|
|
}
|
|
|
|
return apply_filters( 'woocommerce_subscriptions_product_first_renewal_payment_date', $first_renewal_date, $product_id, $from_date, $timezone );
|
|
}
|
|
|
|
/**
|
|
* Takes a subscription product's ID and returns the date on which the first renewal payment will be processed
|
|
* based on the subscription's length and calculated from either the $from_date if specified, or the current date/time.
|
|
*
|
|
* @param int $product_id The product/post ID of a subscription product
|
|
* @param mixed $from_date A MySQL formatted date/time string from which to calculate the expiration date, or empty (default), which will use today's date/time.
|
|
* @param string $type The return format for the date, either 'mysql', or 'timezone'. Default 'mysql'.
|
|
* @param string $timezone The timezone for the returned date, either 'site' for the site's timezone, or 'gmt'. Default, 'site'.
|
|
* @since 2.0
|
|
*/
|
|
public static function get_first_renewal_payment_time( $product_id, $from_date = '', $timezone = 'gmt' ) {
|
|
|
|
if ( ! self::is_subscription( $product_id ) ) {
|
|
return 0;
|
|
}
|
|
|
|
$from_date_param = $from_date;
|
|
|
|
$billing_interval = self::get_interval( $product_id );
|
|
$billing_length = self::get_length( $product_id );
|
|
$trial_length = self::get_trial_length( $product_id );
|
|
|
|
if ( $billing_interval !== $billing_length || $trial_length > 0 ) {
|
|
|
|
if ( empty( $from_date ) ) {
|
|
$from_date = gmdate( 'Y-m-d H:i:s' );
|
|
}
|
|
|
|
// If the subscription has a free trial period, the first renewal payment date is the same as the expiration of the free trial
|
|
if ( $trial_length > 0 ) {
|
|
|
|
$first_renewal_timestamp = wcs_date_to_time( self::get_trial_expiration_date( $product_id, $from_date ) );
|
|
|
|
} else {
|
|
|
|
$first_renewal_timestamp = wcs_add_time( $billing_interval, self::get_period( $product_id ), wcs_date_to_time( $from_date ) );
|
|
|
|
if ( 'site' == $timezone ) {
|
|
$first_renewal_timestamp += ( get_option( 'gmt_offset' ) * HOUR_IN_SECONDS );
|
|
}
|
|
}
|
|
} else {
|
|
$first_renewal_timestamp = 0;
|
|
}
|
|
|
|
return apply_filters( 'woocommerce_subscriptions_product_first_renewal_payment_time', $first_renewal_timestamp, $product_id, $from_date_param, $timezone );
|
|
}
|
|
|
|
/**
|
|
* Takes a subscription product's ID and returns the date on which the subscription product will expire,
|
|
* based on the subscription's length and calculated from either the $from_date if specified, or the current date/time.
|
|
*
|
|
* @param mixed $product_id The product/post ID of the subscription
|
|
* @param mixed $from_date A MySQL formatted date/time string from which to calculate the expiration date, or empty (default), which will use today's date/time.
|
|
* @since 1.0
|
|
*/
|
|
public static function get_expiration_date( $product_id, $from_date = '' ) {
|
|
|
|
$subscription_length = self::get_length( $product_id );
|
|
|
|
if ( $subscription_length > 0 ) {
|
|
|
|
if ( empty( $from_date ) ) {
|
|
$from_date = gmdate( 'Y-m-d H:i:s' );
|
|
}
|
|
|
|
if ( self::get_trial_length( $product_id ) > 0 ) {
|
|
$from_date = self::get_trial_expiration_date( $product_id, $from_date );
|
|
}
|
|
|
|
$expiration_date = gmdate( 'Y-m-d H:i:s', wcs_add_time( $subscription_length, self::get_period( $product_id ), wcs_date_to_time( $from_date ) ) );
|
|
|
|
} else {
|
|
|
|
$expiration_date = 0;
|
|
|
|
}
|
|
|
|
return apply_filters( 'woocommerce_subscriptions_product_expiration_date', $expiration_date, $product_id, $from_date );
|
|
}
|
|
|
|
/**
|
|
* Takes a subscription product's ID and returns the date on which the subscription trial will expire,
|
|
* based on the subscription's trial length and calculated from either the $from_date if specified,
|
|
* or the current date/time.
|
|
*
|
|
* @param int $product_id The product/post ID of the subscription
|
|
* @param mixed $from_date A MySQL formatted date/time string from which to calculate the expiration date (in UTC timezone), or empty (default), which will use today's date/time (in UTC timezone).
|
|
* @since 1.0
|
|
*/
|
|
public static function get_trial_expiration_date( $product_id, $from_date = '' ) {
|
|
|
|
$trial_length = self::get_trial_length( $product_id );
|
|
|
|
if ( $trial_length > 0 ) {
|
|
|
|
if ( empty( $from_date ) ) {
|
|
$from_date = gmdate( 'Y-m-d H:i:s' );
|
|
}
|
|
|
|
$trial_expiration_date = gmdate( 'Y-m-d H:i:s', wcs_add_time( $trial_length, self::get_trial_period( $product_id ), wcs_date_to_time( $from_date ) ) );
|
|
|
|
} else {
|
|
|
|
$trial_expiration_date = 0;
|
|
|
|
}
|
|
|
|
return apply_filters( 'woocommerce_subscriptions_product_trial_expiration_date', $trial_expiration_date, $product_id, $from_date );
|
|
}
|
|
|
|
/**
|
|
* Checks the classname being used for a product variation to see if it should be a subscription product
|
|
* variation, and if so, returns this as the class which should be instantiated (instead of the default
|
|
* WC_Product_Variation class).
|
|
*
|
|
* @return string $classname The name of the WC_Product_* class which should be instantiated to create an instance of this product.
|
|
* @since 1.3
|
|
*/
|
|
public static function set_subscription_variation_class( $classname, $product_type, $post_type, $product_id ) {
|
|
|
|
if ( 'product_variation' === $post_type && 'variation' === $product_type ) {
|
|
|
|
$terms = get_the_terms( get_post( $product_id )->post_parent, 'product_type' );
|
|
|
|
$parent_product_type = ! empty( $terms ) && isset( current( $terms )->slug ) ? current( $terms )->slug : '';
|
|
|
|
if ( 'variable-subscription' === $parent_product_type ) {
|
|
$classname = 'WC_Product_Subscription_Variation';
|
|
}
|
|
}
|
|
|
|
return $classname;
|
|
}
|
|
|
|
/**
|
|
* Ensures a price is displayed for subscription variation where WC would normally ignore it (i.e. when prices are equal).
|
|
*
|
|
* @return array $variation_details Set of name/value pairs representing the subscription.
|
|
* @since 1.3.6
|
|
*/
|
|
public static function maybe_set_variations_price_html( $variation_details, $variable_product, $variation ) {
|
|
|
|
if ( $variable_product->is_type( 'variable-subscription' ) && empty( $variation_details['price_html'] ) ) {
|
|
$variation_details['price_html'] = '<span class="price">' . $variation->get_price_html() . '</span>';
|
|
}
|
|
|
|
return $variation_details;
|
|
}
|
|
|
|
/**
|
|
* Do not allow any user to delete a subscription product if it is associated with an order.
|
|
*
|
|
* Those with appropriate capabilities can still trash the product, but they will not be able to permanently
|
|
* delete the product if it is associated with an order (i.e. been purchased).
|
|
*
|
|
* @since 1.4.9
|
|
*/
|
|
public static function user_can_not_delete_subscription( $allcaps, $caps, $args ) {
|
|
global $wpdb;
|
|
|
|
if ( isset( $args[0] ) && in_array( $args[0], array( 'delete_post', 'delete_product' ) ) && isset( $args[2] ) && ( ! isset( $_GET['action'] ) || 'untrash' != $_GET['action'] ) && 0 === strpos( get_post_type( $args[2] ), 'product' ) ) {
|
|
|
|
$user_id = $args[2];
|
|
$post_id = $args[2];
|
|
$product = wc_get_product( $post_id );
|
|
|
|
if ( false !== $product && 'trash' == wcs_get_objects_property( $product, 'post_status' ) && $product->is_type( array( 'subscription', 'variable-subscription', 'subscription_variation' ) ) ) {
|
|
|
|
$product_id = ( $product->is_type( 'subscription_variation' ) ) ? $product->get_parent_id() : $post_id;
|
|
|
|
$subscription_count = $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM `{$wpdb->prefix}woocommerce_order_itemmeta` WHERE `meta_key` = '_product_id' AND `meta_value` = %d", $product_id ) );
|
|
|
|
if ( $subscription_count > 0 ) {
|
|
$allcaps[ $caps[0] ] = false;
|
|
}
|
|
}
|
|
}
|
|
|
|
return $allcaps;
|
|
}
|
|
|
|
/**
|
|
* Make sure the 'untrash' (i.e. "Restore") row action is displayed.
|
|
*
|
|
* In @see self::user_can_not_delete_subscription() we prevent a store manager being able to delete a subscription product.
|
|
* However, WooCommerce also uses the `delete_post` capability to check whether to display the 'trash' and 'untrash' row actions.
|
|
* We want a store manager to be able to trash and untrash subscriptions, so this function adds them again.
|
|
*
|
|
* @return array $actions Array of actions that can be performed on the post.
|
|
* @return array $post Array of post values for the current product (or post object if it is not a product).
|
|
* @since 1.4.9
|
|
*/
|
|
public static function subscription_row_actions( $actions, $post ) {
|
|
global $the_product;
|
|
|
|
if ( ! empty( $the_product ) && ! isset( $actions['untrash'] ) && $the_product->is_type( array( 'subscription', 'variable-subscription', 'subscription_variation' ) ) ) {
|
|
|
|
$post_type_object = get_post_type_object( $post->post_type );
|
|
|
|
if ( 'trash' == $post->post_status && current_user_can( $post_type_object->cap->edit_post, $post->ID ) ) {
|
|
$actions['untrash'] = "<a
|
|
title='" . esc_attr__( 'Restore this item from the Trash', 'woocommerce-subscriptions' ) . "'
|
|
href='" . wp_nonce_url( admin_url( sprintf( $post_type_object->_edit_link . '&action=untrash', $post->ID ) ), 'untrash-post_' . $post->ID ) . "'>" . __( 'Restore', 'woocommerce-subscriptions' ) . '</a>';
|
|
}
|
|
}
|
|
|
|
return $actions;
|
|
}
|
|
|
|
/**
|
|
* Remove the "Delete Permanently" action from the bulk actions select element on the Products admin screen.
|
|
*
|
|
* Because any subscription products associated with an order can not be permanently deleted (as a result of
|
|
* @see self::user_can_not_delete_subscription() ), leaving the bulk action in can lead to the store manager
|
|
* hitting the "You are not allowed to delete this item" brick wall and not being able to continue with the
|
|
* deletion (or get any more detailed information about which item can't be deleted and why).
|
|
*
|
|
* @return array $actions Array of actions that can be performed on the post.
|
|
* @since 1.4.9
|
|
*/
|
|
public static function subscription_bulk_actions( $actions ) {
|
|
|
|
unset( $actions['delete'] );
|
|
|
|
return $actions;
|
|
}
|
|
|
|
/**
|
|
* Check whether a product has one-time shipping only.
|
|
*
|
|
* @param mixed $product A WC_Product object or product ID
|
|
* @return bool True if the product requires only one time shipping, false otherwise.
|
|
* @since 2.2.0
|
|
*/
|
|
public static function needs_one_time_shipping( $product ) {
|
|
$product = self::maybe_get_product_instance( $product );
|
|
if ( $product && $product->is_type( 'variation' ) && is_callable( array( $product, 'get_parent_id' ) ) ) {
|
|
$product = self::maybe_get_product_instance( $product->get_parent_id() );
|
|
}
|
|
return apply_filters( 'woocommerce_subscriptions_product_needs_one_time_shipping', 'yes' === self::get_meta_data( $product, 'subscription_one_time_shipping', 'no' ), $product );
|
|
}
|
|
|
|
/**
|
|
* Hooked to the @see 'wp_scheduled_delete' WP-Cron scheduled task to rename the '_wp_trash_meta_time' meta value
|
|
* as '_wc_trash_meta_time'. This is the flag used by WordPress to determine which posts should be automatically
|
|
* purged from the trash. We want to make sure Subscriptions products are not automatically purged (but still want
|
|
* to keep a record of when the product was trashed).
|
|
*
|
|
* @since 1.4.9
|
|
*/
|
|
public static function prevent_scheduled_deletion() {
|
|
global $wpdb;
|
|
|
|
$query = "UPDATE $wpdb->postmeta
|
|
INNER JOIN $wpdb->posts ON $wpdb->postmeta.post_id = $wpdb->posts.ID
|
|
SET $wpdb->postmeta.meta_key = '_wc_trash_meta_time'
|
|
WHERE $wpdb->postmeta.meta_key = '_wp_trash_meta_time'
|
|
AND $wpdb->posts.post_type IN ( 'product', 'product_variation')
|
|
AND $wpdb->posts.post_status = 'trash'";
|
|
|
|
$wpdb->query( $query );
|
|
}
|
|
|
|
/**
|
|
* Trash subscription variations - don't delete them permanently.
|
|
*
|
|
* This is hooked to 'wp_ajax_woocommerce_remove_variation' & 'wp_ajax_woocommerce_remove_variations'
|
|
* before WooCommerce's WC_AJAX::remove_variation() or WC_AJAX::remove_variations() functions are run.
|
|
* The WooCommerce functions will still run after this, but if the variation is a subscription, the
|
|
* request will either terminate or in the case of bulk deleting, the variation's ID will be removed
|
|
* from the $_POST.
|
|
*
|
|
* @since 1.4.9
|
|
*/
|
|
public static function remove_variations() {
|
|
|
|
if ( isset( $_POST['variation_id'] ) ) { // removing single variation
|
|
|
|
check_ajax_referer( 'delete-variation', 'security' );
|
|
$variation_ids = array( $_POST['variation_id'] );
|
|
|
|
} else { // removing multiple variations
|
|
|
|
check_ajax_referer( 'delete-variations', 'security' );
|
|
$variation_ids = (array) $_POST['variation_ids'];
|
|
|
|
}
|
|
|
|
foreach ( $variation_ids as $index => $variation_id ) {
|
|
|
|
$variation_post = get_post( $variation_id );
|
|
|
|
if ( $variation_post && $variation_post->post_type == 'product_variation' ) {
|
|
|
|
$variation_product = wc_get_product( $variation_id );
|
|
|
|
if ( $variation_product && $variation_product->is_type( 'subscription_variation' ) ) {
|
|
|
|
wp_trash_post( $variation_id );
|
|
|
|
// Prevent WooCommerce deleting the variation
|
|
if ( isset( $_POST['variation_id'] ) ) {
|
|
die();
|
|
} else {
|
|
unset( $_POST['variation_ids'][ $index ] );
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Save variation meta data when it is bulk edited from the Edit Product screen
|
|
*
|
|
* @param string $bulk_action The bulk edit action being performed
|
|
* @param array $data An array of data relating to the bulk edit action. $data['value'] represents the new value for the meta.
|
|
* @param int $variable_product_id The post ID of the parent variable product.
|
|
* @param array $variation_ids An array of post IDs for the variable prodcut's variations.
|
|
* @since 1.5.29
|
|
*/
|
|
public static function bulk_edit_variations( $bulk_action, $data, $variable_product_id, $variation_ids ) {
|
|
|
|
if ( ! isset( $data['value'] ) ) {
|
|
return;
|
|
} elseif ( WC_Subscriptions::is_woocommerce_pre( '2.5' ) ) {
|
|
// Pre 2.5 we don't have the product type information available so we have to check if it is a subscription - downside here is this only works if the product has already been saved
|
|
if ( ! self::is_subscription( $variable_product_id ) ) {
|
|
return;
|
|
}
|
|
} else {
|
|
// Since 2.5 we have the product type information available so we don't have to wait for the product to be saved to check if it is a subscription
|
|
if ( empty( $_POST['security'] ) || ! wp_verify_nonce( $_POST['security'], 'bulk-edit-variations' ) || 'variable-subscription' !== $_POST['product_type'] ) {
|
|
return;
|
|
}
|
|
}
|
|
|
|
$meta_key = str_replace( 'variable', '', $bulk_action );
|
|
|
|
// Update the subscription price when updating regular price on a variable subscription product
|
|
if ( '_regular_price' == $meta_key ) {
|
|
$meta_key = '_subscription_price';
|
|
}
|
|
|
|
if ( in_array( $meta_key, self::$subscription_meta_fields ) ) {
|
|
foreach ( $variation_ids as $variation_id ) {
|
|
update_post_meta( $variation_id, $meta_key, stripslashes( $data['value'] ) );
|
|
}
|
|
} elseif ( in_array( $meta_key, array( '_regular_price_increase', '_regular_price_decrease' ) ) ) {
|
|
$operator = ( '_regular_price_increase' == $meta_key ) ? '+' : '-';
|
|
$value = wc_clean( $data['value'] );
|
|
|
|
foreach ( $variation_ids as $variation_id ) {
|
|
$subscription_price = get_post_meta( $variation_id, '_subscription_price', true );
|
|
|
|
if ( '%' === substr( $value, -1 ) ) {
|
|
$percent = wc_format_decimal( substr( $value, 0, -1 ) );
|
|
$subscription_price += ( ( $subscription_price / 100 ) * $percent ) * "{$operator}1";
|
|
} else {
|
|
$subscription_price += $value * "{$operator}1";
|
|
}
|
|
|
|
update_post_meta( $variation_id, '_subscription_price', $subscription_price );
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
*
|
|
* Hooked to `woocommerce_product_after_variable_attributes`.
|
|
* This function adds a hidden field to the backend's HTML output of product variations indicating whether the
|
|
* variation is being used in subscriptions or not.
|
|
* This is used by some admin JS code to prevent removal of certain variations and also display a tooltip message to the
|
|
* admin.
|
|
*
|
|
* @param int $loop Position of the variation inside the variations loop.
|
|
* @param array $variation_data Array of variation data.
|
|
* @param WP_Post $variation The variation's WP post.
|
|
* @since 2.2.17
|
|
*/
|
|
public static function add_variation_removal_flag( $loop, $variation_data, $variation ) {
|
|
$related_subscriptions = wcs_get_subscriptions_for_product( $variation->ID );
|
|
$can_remove = empty( $related_subscriptions );
|
|
|
|
printf( '<input type="hidden" class="wcs-can-remove-variation" value="%d" />', intval( $can_remove ) );
|
|
|
|
if ( ! $can_remove ) {
|
|
$msg = __( 'This variation can not be removed because it is associated with active subscriptions. To remove this variation, please cancel and delete the subscriptions for it.', 'woocommerce-subscriptions' );
|
|
printf( '<a href="#" class="tips delete wcs-can-not-remove-variation-msg" data-tip="%s"></a>', wc_sanitize_tooltip( $msg ) ); // XSS ok.
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Processes an AJAX request to check if a product has a variation which is either sync'd or has a trial.
|
|
* Once at least one variation with a trial or sync date is found, this will terminate and return true, otherwise false.
|
|
*
|
|
* @since 2.0.18
|
|
*/
|
|
public static function check_product_variations_for_syncd_or_trial() {
|
|
|
|
check_admin_referer( 'one_time_shipping', 'nonce' );
|
|
|
|
$product = wc_get_product( $_POST['product_id'] );
|
|
$is_synced_or_has_trial = false;
|
|
|
|
if ( WC_Subscriptions_Product::is_subscription( $product ) ) {
|
|
|
|
foreach ( $product->get_children() as $variation_id ) {
|
|
|
|
if ( isset( $_POST['variations_checked'] ) && in_array( $variation_id, $_POST['variations_checked'] ) ) {
|
|
continue;
|
|
}
|
|
|
|
$variation_product = wc_get_product( $variation_id );
|
|
|
|
if ( WC_Subscriptions_Product::get_trial_length( $variation_product ) ) {
|
|
$is_synced_or_has_trial = true;
|
|
break;
|
|
}
|
|
|
|
if ( WC_Subscriptions_Synchroniser::is_product_synced( $variation_product ) ) {
|
|
$is_synced_or_has_trial = true;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
wp_send_json( array( 'is_synced_or_has_trial' => $is_synced_or_has_trial ) );
|
|
}
|
|
|
|
/**
|
|
* Processes an AJAX request to update a product's One Time Shipping setting after a bulk variation edit has been made.
|
|
* After bulk edits (variation level saving as well as variation bulk actions), variation data has been updated in the
|
|
* database and therefore doesn't require the product global settings to be updated by the user for the changes to take effect.
|
|
* This function, triggered after saving variations or triggering the trial length bulk action, ensures one time shipping settings
|
|
* are updated after determining if one time shipping is still available to the product.
|
|
*
|
|
* @since 2.0.18
|
|
*/
|
|
public static function maybe_update_one_time_shipping_on_variation_edits() {
|
|
|
|
check_admin_referer( 'one_time_shipping', 'nonce' );
|
|
|
|
$one_time_shipping_enabled = $_POST['one_time_shipping_enabled'];
|
|
$one_time_shipping_selected = $_POST['one_time_shipping_selected'];
|
|
$subscription_one_time_shipping = 'no';
|
|
|
|
if ( 'false' !== $one_time_shipping_enabled && 'true' === $one_time_shipping_selected ) {
|
|
$subscription_one_time_shipping = 'yes';
|
|
}
|
|
|
|
update_post_meta( $_POST['product_id'], '_subscription_one_time_shipping', $subscription_one_time_shipping );
|
|
|
|
wp_send_json( array( 'one_time_shipping' => $subscription_one_time_shipping ) );
|
|
}
|
|
|
|
/**
|
|
* Wrapper to check whether we have a product ID or product and if we have the former, return the later.
|
|
*
|
|
* @param mixed $product A WC_Product object or product ID
|
|
* @return WC_Product
|
|
* @since 2.2.0
|
|
*/
|
|
private static function maybe_get_product_instance( $product ) {
|
|
|
|
if ( ! is_object( $product ) || ! is_a( $product, 'WC_Product' ) ) {
|
|
$product = wc_get_product( $product );
|
|
}
|
|
|
|
return $product;
|
|
}
|
|
|
|
/**
|
|
* Get a piece of subscription related meta data for a product in a version compatible way.
|
|
*
|
|
* @param mixed $product A WC_Product object or product ID
|
|
* @param string $meta_key The string key for the meta data
|
|
* @param mixed $default_value The value to return if the meta doesn't exist or isn't set
|
|
* @param string $empty_handling (optional) How empty values should be handled -- can be 'use_default_value' or 'allow_empty'. Defaults to 'allow_empty' returning the empty value.
|
|
* @return mixed
|
|
* @since 2.2.0
|
|
*/
|
|
public static function get_meta_data( $product, $meta_key, $default_value, $empty_handling = 'allow_empty' ) {
|
|
|
|
$product = self::maybe_get_product_instance( $product );
|
|
|
|
$meta_value = $default_value;
|
|
|
|
if ( self::is_subscription( $product ) ) {
|
|
|
|
if ( is_callable( array( $product, 'meta_exists' ) ) ) { // WC 3.0
|
|
|
|
$prefixed_key = wcs_maybe_prefix_key( $meta_key );
|
|
|
|
// Only set the meta value when the object has a meta value to workaround ambiguous default return values
|
|
if ( $product->meta_exists( $prefixed_key ) ) {
|
|
$meta_value = $product->get_meta( $prefixed_key, true );
|
|
}
|
|
} elseif ( isset( $product->{$meta_key} ) ) { // WC < 3.0
|
|
$meta_value = $product->{$meta_key};
|
|
}
|
|
}
|
|
|
|
if ( 'use_default_value' === $empty_handling && empty( $meta_value ) ) {
|
|
$meta_value = $default_value;
|
|
}
|
|
|
|
return $meta_value;
|
|
}
|
|
|
|
/**
|
|
* sync variable product min/max prices with WC 3.0
|
|
*
|
|
* @param WC_Product_Variable $product
|
|
* @since 2.2.0
|
|
*/
|
|
public static function variable_subscription_product_sync( $product ) {
|
|
|
|
if ( self::is_subscription( $product ) ) {
|
|
|
|
$child_variation_ids = $product->get_visible_children();
|
|
|
|
if ( $child_variation_ids ) {
|
|
|
|
$min_max_data = wcs_get_min_max_variation_data( $product, $child_variation_ids );
|
|
|
|
$product->add_meta_data( '_min_price_variation_id', $min_max_data['min']['variation_id'], true );
|
|
$product->add_meta_data( '_max_price_variation_id', $min_max_data['max']['variation_id'], true );
|
|
|
|
$product->add_meta_data( '_min_variation_price', $min_max_data['min']['price'], true );
|
|
$product->add_meta_data( '_max_variation_price', $min_max_data['max']['price'], true );
|
|
$product->add_meta_data( '_min_variation_regular_price', $min_max_data['min']['regular_price'], true );
|
|
$product->add_meta_data( '_max_variation_regular_price', $min_max_data['max']['regular_price'], true );
|
|
$product->add_meta_data( '_min_variation_sale_price', $min_max_data['min']['sale_price'], true );
|
|
$product->add_meta_data( '_max_variation_sale_price', $min_max_data['max']['sale_price'], true );
|
|
|
|
$product->add_meta_data( '_min_variation_period', $min_max_data['min']['period'], true );
|
|
$product->add_meta_data( '_max_variation_period', $min_max_data['max']['period'], true );
|
|
$product->add_meta_data( '_min_variation_period_interval', $min_max_data['min']['interval'], true );
|
|
$product->add_meta_data( '_max_variation_period_interval', $min_max_data['max']['interval'], true );
|
|
|
|
$product->add_meta_data( '_subscription_price', $min_max_data['min']['price'], true );
|
|
$product->add_meta_data( '_subscription_period', $min_max_data['min']['period'], true );
|
|
$product->add_meta_data( '_subscription_period_interval', $min_max_data['min']['interval'], true );
|
|
$product->add_meta_data( '_subscription_sign_up_fee', $min_max_data['subscription']['signup-fee'], true );
|
|
$product->add_meta_data( '_subscription_trial_period', $min_max_data['subscription']['trial_period'], true );
|
|
$product->add_meta_data( '_subscription_trial_length', $min_max_data['subscription']['trial_length'], true );
|
|
$product->add_meta_data( '_subscription_length', $min_max_data['subscription']['length'], true );
|
|
}
|
|
}
|
|
|
|
return $product;
|
|
}
|
|
|
|
/**
|
|
* Get an array of parent IDs from a potential child product, used to determine if a product belongs to a group.
|
|
*
|
|
* @param WC_Product The product object to get parents from.
|
|
* @return array Parent IDs
|
|
* @since 2.2.4
|
|
*/
|
|
public static function get_parent_ids( $product ) {
|
|
global $wpdb;
|
|
$parent_product_ids = array();
|
|
|
|
if ( WC_Subscriptions::is_woocommerce_pre( '3.0' ) && $product->get_parent() ) {
|
|
$parent_product_ids[] = $product->get_parent();
|
|
} else {
|
|
$parent_product_ids = $wpdb->get_col( $wpdb->prepare(
|
|
"SELECT post_id
|
|
FROM {$wpdb->prefix}postmeta
|
|
WHERE meta_key = '_children' AND meta_value LIKE '%%i:%d;%%'",
|
|
$product->get_id()
|
|
) );
|
|
}
|
|
|
|
return $parent_product_ids;
|
|
}
|
|
|
|
/************************
|
|
* Deprecated Functions *
|
|
************************/
|
|
|
|
/**
|
|
* 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 2.0
|
|
* @return bool
|
|
*/
|
|
public static function is_purchasable( $is_purchasable, $product ) {
|
|
_deprecated_function( __METHOD__, '2.1', 'WCS_Limiter::is_purchasable_product' );
|
|
return WCS_Limiter::is_purchasable_product( $is_purchasable, $product );
|
|
}
|
|
|
|
/**
|
|
* Check if the current session has an order awaiting payment for a subscription to a specific product line item.
|
|
*
|
|
* @return 2.0.13
|
|
* @return bool
|
|
**/
|
|
protected static function order_awaiting_payment_for_product( $product_id ) {
|
|
_deprecated_function( __METHOD__, '2.1', 'WCS_Limiter::order_awaiting_payment_for_product' );
|
|
|
|
global $wp;
|
|
|
|
if ( ! isset( self::$order_awaiting_payment_for_product[ $product_id ] ) ) {
|
|
|
|
self::$order_awaiting_payment_for_product[ $product_id ] = false;
|
|
|
|
if ( ! empty( WC()->session->order_awaiting_payment ) || isset( $_GET['pay_for_order'] ) ) {
|
|
|
|
$order_id = ! empty( WC()->session->order_awaiting_payment ) ? WC()->session->order_awaiting_payment : $wp->query_vars['order-pay'];
|
|
$order = wc_get_order( absint( $order_id ) );
|
|
|
|
if ( is_object( $order ) && $order->has_status( array( 'pending', 'failed' ) ) ) {
|
|
foreach ( $order->get_items() as $item ) {
|
|
if ( $item['product_id'] == $product_id || $item['variation_id'] == $product_id ) {
|
|
|
|
$subscriptions = wcs_get_subscriptions( array(
|
|
'order_id' => wcs_get_objects_property( $order, 'id' ),
|
|
'product_id' => $product_id,
|
|
) );
|
|
|
|
if ( ! empty( $subscriptions ) ) {
|
|
$subscription = array_pop( $subscriptions );
|
|
|
|
if ( $subscription->has_status( array( 'pending', 'on-hold' ) ) ) {
|
|
self::$order_awaiting_payment_for_product[ $product_id ] = true;
|
|
}
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return self::$order_awaiting_payment_for_product[ $product_id ];
|
|
}
|
|
|
|
/**
|
|
* Returns the sign up fee (including tax) by filtering the products price used in
|
|
* @see WC_Product::get_price_including_tax( $qty )
|
|
*
|
|
* @return string
|
|
*/
|
|
public static function get_sign_up_fee_including_tax( $product, $qty = 1 ) {
|
|
wcs_deprecated_function( __METHOD__, '2.2.0', 'wcs_get_price_including_tax( $product, array( "qty" => $qty, "price" => WC_Subscriptions_Product::get_sign_up_fee( $product ) ) )' );
|
|
return wcs_get_price_including_tax( $product, array( 'qty' => $qty, 'price' => WC_Subscriptions_Product::get_sign_up_fee( $product ) ) );
|
|
}
|
|
|
|
/**
|
|
* Returns the sign up fee (excluding tax) by filtering the products price used in
|
|
* @see WC_Product::get_price_excluding_tax( $qty )
|
|
*
|
|
* @return string
|
|
*/
|
|
public static function get_sign_up_fee_excluding_tax( $product, $qty = 1 ) {
|
|
wcs_deprecated_function( __METHOD__, '2.2.0', 'wcs_get_price_excluding_tax( $product, array( "qty" => $qty, "price" => WC_Subscriptions_Product::get_sign_up_fee( $product ) ) )' );
|
|
return wcs_get_price_excluding_tax( $product, array( 'qty' => $qty, 'price' => WC_Subscriptions_Product::get_sign_up_fee( $product ) ) );
|
|
}
|
|
}
|
|
|
|
WC_Subscriptions_Product::init();
|