mirror of
https://github.com/pronamic/woocommerce-subscriptions.git
synced 2025-10-17 14:52:56 +00:00
2284 lines
95 KiB
PHP
2284 lines
95 KiB
PHP
<?php
|
|
/**
|
|
* Subscriptions Admin Class
|
|
*
|
|
* Adds a Subscription setting tab and saves subscription settings. Adds a Subscriptions Management page. Adds
|
|
* Welcome messages and pointers to streamline learning process for new users.
|
|
*
|
|
* @package WooCommerce Subscriptions
|
|
* @subpackage WC_Subscriptions_Admin
|
|
* @category Class
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.0
|
|
*/
|
|
class WC_Subscriptions_Admin {
|
|
|
|
/**
|
|
* The WooCommerce settings tab name
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.0
|
|
*/
|
|
public static $tab_name = 'subscriptions';
|
|
|
|
/**
|
|
* The prefix for subscription settings
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.0
|
|
*/
|
|
public static $option_prefix = 'woocommerce_subscriptions';
|
|
|
|
/**
|
|
* Store an instance of the list table
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.4.6
|
|
*/
|
|
private static $subscriptions_list_table;
|
|
|
|
/**
|
|
* Store an instance of the list table
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
|
|
*/
|
|
private static $found_related_orders = false;
|
|
|
|
/**
|
|
* Is meta boxes saved once?
|
|
*
|
|
* @var boolean
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.2.0
|
|
*/
|
|
private static $saved_product_meta = false;
|
|
|
|
/**
|
|
* Bootstraps the class and hooks required actions & filters.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.0
|
|
*/
|
|
public static function init() {
|
|
|
|
// Add subscriptions to the product select box
|
|
add_filter( 'product_type_selector', __CLASS__ . '::add_subscription_products_to_select' );
|
|
|
|
// Special handling of downloadable and virtual products on the WooCommerce > Products screen.
|
|
add_filter( 'product_type_selector', array( __CLASS__, 'add_downloadable_and_virtual_filters' ) );
|
|
add_filter( 'request', array( __CLASS__, 'modify_downloadable_and_virtual_product_queries' ), 11 );
|
|
|
|
// Add subscription pricing fields on edit product page
|
|
add_action( 'woocommerce_product_options_general_product_data', __CLASS__ . '::subscription_pricing_fields' );
|
|
|
|
// Add listener to clear our own transients when WooCommerce -> Clear Transients is
|
|
// triggered from the admin panel
|
|
add_action( 'woocommerce_page_wc-status', __CLASS__ . '::clear_subscriptions_transients' );
|
|
|
|
// Add subscription shipping options on edit product page
|
|
if ( wcs_is_woocommerce_pre( '6.0' ) ) {
|
|
add_action( 'woocommerce_product_options_shipping', __CLASS__ . '::subscription_shipping_fields' );
|
|
} else {
|
|
add_action( 'woocommerce_product_options_shipping_product_data', __CLASS__ . '::subscription_shipping_fields' );
|
|
}
|
|
|
|
// And also on the variations section
|
|
add_action( 'woocommerce_product_after_variable_attributes', __CLASS__ . '::variable_subscription_pricing_fields', 10, 3 );
|
|
|
|
// Add bulk edit actions for variable subscription products
|
|
add_action( 'woocommerce_variable_product_bulk_edit_actions', __CLASS__ . '::variable_subscription_bulk_edit_actions', 10 );
|
|
|
|
// Save subscription meta when a subscription product is changed via bulk edit
|
|
add_action( 'woocommerce_product_bulk_edit_save', __CLASS__ . '::bulk_edit_save_subscription_meta', 10 );
|
|
|
|
// Save subscription meta only when a subscription product is saved, can't run on the "'woocommerce_process_product_meta_' . $product_type" action because we need to override some WC defaults
|
|
add_action( 'save_post', __CLASS__ . '::save_subscription_meta', 11 );
|
|
add_action( 'save_post', __CLASS__ . '::save_variable_subscription_meta', 11 );
|
|
|
|
// Save variable subscription meta
|
|
add_action( 'woocommerce_process_product_meta_variable-subscription', __CLASS__ . '::process_product_meta_variable_subscription' );
|
|
add_action( 'woocommerce_save_product_variation', __CLASS__ . '::save_product_variation', 20, 2 );
|
|
|
|
add_action( 'woocommerce_subscription_pre_update_status', __CLASS__ . '::check_customer_is_set', 10, 3 );
|
|
|
|
add_action( 'product_variation_linked', __CLASS__ . '::set_variation_meta_defaults_on_bulk_add' );
|
|
|
|
add_filter( 'woocommerce_settings_tabs_array', __CLASS__ . '::add_subscription_settings_tab', 50 );
|
|
|
|
add_action( 'woocommerce_settings_subscriptions', __CLASS__ . '::subscription_settings_page' );
|
|
|
|
add_action( 'woocommerce_update_options_' . self::$tab_name, __CLASS__ . '::update_subscription_settings' );
|
|
|
|
add_filter( 'manage_users_columns', __CLASS__ . '::add_user_columns', 11, 1 );
|
|
|
|
add_filter( 'manage_users_custom_column', __CLASS__ . '::user_column_values', 11, 3 ); // Fire after default to avoid being broken by plugins #doing_it_wrong
|
|
|
|
add_action( 'admin_enqueue_scripts', __CLASS__ . '::enqueue_styles_scripts' );
|
|
|
|
add_action( 'woocommerce_admin_field_informational', __CLASS__ . '::add_informational_admin_field' );
|
|
|
|
// Filter Orders list table.
|
|
add_filter( 'posts_where', array( __CLASS__, 'filter_orders' ) );
|
|
add_filter( 'woocommerce_shop_order_list_table_prepare_items_query_args', [ __CLASS__, 'filter_orders_table_by_related_orders' ] );
|
|
|
|
// Filter get_posts used by Subscription Reports.
|
|
add_filter( 'posts_where', array( __CLASS__, 'filter_orders_and_subscriptions_from_list' ) );
|
|
add_filter( 'posts_where', array( __CLASS__, 'filter_paid_subscription_orders_for_user' ) );
|
|
|
|
// Filter Order and Subscriptions used by Subscription Reports.
|
|
add_filter( 'woocommerce_orders_table_query_clauses', array( __CLASS__, 'filter_orders_and_subscriptions_from_order_table' ) );
|
|
|
|
add_action( 'admin_notices', __CLASS__ . '::display_renewal_filter_notice' );
|
|
|
|
add_shortcode( 'subscriptions', __CLASS__ . '::do_subscriptions_shortcode' );
|
|
|
|
add_filter( 'set-screen-option', __CLASS__ . '::set_manage_subscriptions_screen_option', 10, 3 );
|
|
|
|
add_filter( 'woocommerce_payment_gateways_setting_columns', array( __CLASS__, 'payment_gateways_renewal_column' ) );
|
|
|
|
add_action( 'woocommerce_payment_gateways_setting_column_renewals', array( __CLASS__, 'payment_gateways_renewal_support' ) );
|
|
|
|
add_action( 'woocommerce_payment_gateways_settings', __CLASS__ . '::add_recurring_payment_gateway_information', 10, 1 );
|
|
|
|
// Change text for when order items cannot be edited
|
|
wcs_add_woocommerce_dependent_action( 'woocommerce_admin_order_totals_after_total', array( __CLASS__, 'maybe_attach_gettext_callback' ), '4.0.0', '>' );
|
|
wcs_add_woocommerce_dependent_action( 'woocommerce_admin_order_totals_after_refunded', array( __CLASS__, 'maybe_attach_gettext_callback' ), '4.0.0', '<' );
|
|
|
|
// Unhook gettext callback to prevent extra call impact
|
|
add_action( 'woocommerce_order_item_add_action_buttons', __CLASS__ . '::maybe_unattach_gettext_callback', 10, 1 );
|
|
|
|
// Add a reminder on the enable guest checkout setting that subscriptions still require an account
|
|
add_filter( 'woocommerce_payment_gateways_settings', array( __CLASS__, 'add_guest_checkout_setting_note' ), 10, 1 );
|
|
add_filter( 'woocommerce_account_settings', array( __CLASS__, 'add_guest_checkout_setting_note' ), 10, 1 );
|
|
|
|
// Validate the product type change before other product changes are saved.
|
|
add_action( 'woocommerce_process_product_meta', array( __CLASS__, 'validate_product_type_change' ), 5 );
|
|
|
|
// Allow admin to enable account creation specifically for subscription purchases.
|
|
add_filter( 'woocommerce_account_settings', array( __CLASS__, 'add_registration_for_subscription_purchases_setting' ), 10, 1 );
|
|
|
|
// Prevent variations from being deleted if switching from a variable product type to a variable product type.
|
|
add_filter( 'woocommerce_delete_variations_on_product_type_change', array( __CLASS__, 'maybe_keep_variations' ), 10, 4 );
|
|
}
|
|
|
|
/**
|
|
* Clear all transients data we have when the WooCommerce::Tools::Clear Transients action is
|
|
* triggered.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.1.1
|
|
*/
|
|
public static function clear_subscriptions_transients() {
|
|
global $wpdb;
|
|
if ( empty( $_GET['action'] ) || empty( $_REQUEST['_wpnonce'] ) || ! wp_verify_nonce( wc_clean( wp_unslash( $_REQUEST['_wpnonce'] ) ), 'debug_action' ) ) {
|
|
return;
|
|
}
|
|
|
|
if ( wc_clean( $_GET['action'] ) === 'clear_transients' ) {
|
|
$transients_to_delete = array(
|
|
'wc_report_subscription_by_product',
|
|
'wc_report_subscription_by_customer',
|
|
'wc_report_subscription_events_by_date',
|
|
'wcs_report_subscription_by_product',
|
|
'wcs_report_subscription_by_customer',
|
|
'wcs_report_subscription_events_by_date',
|
|
'wcs_report_upcoming_recurring_revenue',
|
|
);
|
|
|
|
// Get all related order and subscription ranges transients
|
|
$results = $wpdb->get_col(
|
|
"SELECT DISTINCT `option_name`
|
|
FROM `$wpdb->options`
|
|
WHERE `option_name` LIKE '%wcs-related-orders-to-%' OR `option_name` LIKE '%wcs-sub-ranges-%'"
|
|
);
|
|
|
|
foreach ( $results as $column ) {
|
|
$name = explode( 'transient_', $column, 2 );
|
|
$transients_to_delete[] = $name[1];
|
|
}
|
|
|
|
foreach ( $transients_to_delete as $transient_to_delete ) {
|
|
delete_transient( $transient_to_delete );
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Add the 'subscriptions' product type to the WooCommerce product type select box.
|
|
*
|
|
* @param array $product_types Array of Product types & their labels, excluding the Subscription product type.
|
|
* @return array Array of Product types & their labels, including the Subscription product type.
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.0
|
|
*/
|
|
public static function add_subscription_products_to_select( $product_types ) {
|
|
|
|
$product_types['subscription'] = __( 'Simple subscription', 'woocommerce-subscriptions' );
|
|
$product_types['variable-subscription'] = __( 'Variable subscription', 'woocommerce-subscriptions' );
|
|
|
|
return $product_types;
|
|
}
|
|
|
|
/**
|
|
* Add options for downloadable and virtual subscription products to the product type selector on the WooCommerce products screen.
|
|
*
|
|
* @param array $product_types
|
|
* @return array
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.5.1
|
|
*/
|
|
public static function add_downloadable_and_virtual_filters( $product_types ) {
|
|
global $typenow;
|
|
|
|
if ( ! is_admin() || ! doing_action( 'restrict_manage_posts' ) || 'product' !== $typenow ) {
|
|
return $product_types;
|
|
}
|
|
|
|
$product_options = array_reverse(
|
|
array(
|
|
'downloadable_subscription' => ( is_rtl() ? '←' : '→' ) . ' ' . __( 'Downloadable', 'woocommerce-subscriptions' ),
|
|
'virtual_subscription' => ( is_rtl() ? '←' : '→' ) . ' ' . __( 'Virtual', 'woocommerce-subscriptions' ),
|
|
)
|
|
);
|
|
foreach ( $product_options as $key => $label ) {
|
|
$product_types = wcs_array_insert_after( 'subscription', $product_types, $key, $label );
|
|
}
|
|
|
|
return $product_types;
|
|
}
|
|
|
|
/**
|
|
* Modifies the main query on the WooCommerce products screen to correctly handle filtering by virtual and downloadable
|
|
* product types.
|
|
*
|
|
* @param array $query_vars
|
|
* @return array $query_vars
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.5.1
|
|
*/
|
|
public static function modify_downloadable_and_virtual_product_queries( $query_vars ) {
|
|
global $pagenow, $typenow;
|
|
|
|
if ( ! is_admin() || 'edit.php' !== $pagenow || 'product' !== $typenow ) {
|
|
return $query_vars;
|
|
}
|
|
|
|
$current_product_type = isset( $_REQUEST['product_type'] ) ? wc_clean( wp_unslash( $_REQUEST['product_type'] ) ) : false;
|
|
|
|
if ( ! $current_product_type ) {
|
|
return $query_vars;
|
|
}
|
|
|
|
if ( in_array( $current_product_type, array( 'downloadable', 'virtual' ) ) && ! isset( $query_vars['tax_query'] ) ) {
|
|
// Do not include subscriptions when the default "Downloadable" or "Virtual" query for simple products is being executed.
|
|
$query_vars['tax_query'] = array(
|
|
array(
|
|
'taxonomy' => 'product_type',
|
|
'terms' => array( 'subscription' ),
|
|
'field' => 'slug',
|
|
'operator' => 'NOT IN',
|
|
),
|
|
);
|
|
} elseif ( in_array( $current_product_type, array( 'downloadable_subscription', 'virtual_subscription' ) ) ) {
|
|
// Limit query to subscription products when the "Downloadable" or "Virtual" choices under "Simple Subscription" are being used.
|
|
$query_vars['meta_value'] = 'yes';
|
|
$query_vars['meta_key'] = '_' . str_replace( '_subscription', '', $current_product_type );
|
|
$query_vars['product_type'] = 'subscription';
|
|
}
|
|
|
|
return $query_vars;
|
|
}
|
|
|
|
/**
|
|
* Output the subscription specific pricing fields on the "Edit Product" admin page.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.0
|
|
*/
|
|
public static function subscription_pricing_fields() {
|
|
global $post;
|
|
|
|
$chosen_price = get_post_meta( $post->ID, '_subscription_price', true );
|
|
$chosen_interval = get_post_meta( $post->ID, '_subscription_period_interval', true );
|
|
$chosen_trial_length = WC_Subscriptions_Product::get_trial_length( $post->ID );
|
|
$chosen_trial_period = WC_Subscriptions_Product::get_trial_period( $post->ID );
|
|
|
|
$price_tooltip = __( 'Choose the subscription price, billing interval and period.', 'woocommerce-subscriptions' );
|
|
// translators: placeholder is trial period validation message if passed an invalid value (e.g. "Trial period can not exceed 4 weeks")
|
|
$trial_tooltip = sprintf( _x( 'An optional period of time to wait before charging the first recurring payment. Any sign up fee will still be charged at the outset of the subscription. %s', 'Trial period field tooltip on Edit Product administration screen', 'woocommerce-subscriptions' ), self::get_trial_period_validation_message() );
|
|
|
|
// Set month as the default billing period
|
|
$chosen_period = get_post_meta( $post->ID, '_subscription_period', true );
|
|
if ( ! $chosen_period ) {
|
|
$chosen_period = 'month';
|
|
}
|
|
|
|
echo '<div class="options_group subscription_pricing show_if_subscription hidden">';
|
|
|
|
// Subscription Price, Interval and Period
|
|
?><p class="form-field _subscription_price_fields _subscription_price_field">
|
|
<label for="_subscription_price">
|
|
<?php
|
|
// translators: %s: currency symbol.
|
|
printf( esc_html__( 'Subscription price (%s)', 'woocommerce-subscriptions' ), esc_html( get_woocommerce_currency_symbol() ) );
|
|
?>
|
|
</label>
|
|
<span class="wrap">
|
|
<?php // Translators: %s: formatted example price value. ?>
|
|
<input type="text" id="_subscription_price" name="_subscription_price" class="wc_input_price wc_input_subscription_price" placeholder="<?php echo esc_attr( sprintf( _x( 'e.g. %s', 'example price', 'woocommerce-subscriptions' ), wc_format_localized_price( '5.90' ) ) ); ?>" step="any" min="0" value="<?php echo esc_attr( wc_format_localized_price( $chosen_price ) ); ?>" />
|
|
<label for="_subscription_period_interval" class="wcs_hidden_label"><?php esc_html_e( 'Subscription interval', 'woocommerce-subscriptions' ); ?></label>
|
|
<select id="_subscription_period_interval" name="_subscription_period_interval" class="wc_input_subscription_period_interval wc-enhanced-select">
|
|
<?php foreach ( wcs_get_subscription_period_interval_strings() as $value => $label ) { ?>
|
|
<option value="<?php echo esc_attr( $value ); ?>" <?php selected( $value, $chosen_interval, true ); ?>><?php echo esc_html( $label ); ?></option>
|
|
<?php } ?>
|
|
</select>
|
|
<label for="_subscription_period" class="wcs_hidden_label"><?php esc_html_e( 'Subscription period', 'woocommerce-subscriptions' ); ?></label>
|
|
<select id="_subscription_period" name="_subscription_period" class="wc_input_subscription_period last wc-enhanced-select" >
|
|
<?php foreach ( wcs_get_subscription_period_strings() as $value => $label ) { ?>
|
|
<option value="<?php echo esc_attr( $value ); ?>" <?php selected( $value, $chosen_period, true ); ?>><?php echo esc_html( $label ); ?></option>
|
|
<?php } ?>
|
|
</select>
|
|
</span>
|
|
<?php
|
|
// @phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
|
|
echo wcs_help_tip( $price_tooltip );
|
|
?>
|
|
</p>
|
|
<?php
|
|
|
|
// Subscription Length
|
|
woocommerce_wp_select(
|
|
array(
|
|
'id' => '_subscription_length',
|
|
'class' => 'wc_input_subscription_length select short wc-enhanced-select',
|
|
'label' => __( 'Stop renewing after', 'woocommerce-subscriptions' ),
|
|
'options' => wcs_get_subscription_ranges( $chosen_period ),
|
|
'desc_tip' => true,
|
|
'description' => __( 'Automatically stop renewing the subscription after this length of time. This length is in addition to any free trial or amount of time provided before a synchronised first renewal date.', 'woocommerce-subscriptions' ),
|
|
)
|
|
);
|
|
|
|
// Sign-up Fee
|
|
woocommerce_wp_text_input(
|
|
array(
|
|
'id' => '_subscription_sign_up_fee',
|
|
// Keep wc_input_subscription_intial_price for backward compatibility.
|
|
'class' => 'wc_input_subscription_intial_price wc_input_subscription_initial_price wc_input_price short',
|
|
// translators: %s is a currency symbol / code
|
|
'label' => sprintf( __( 'Sign-up fee (%s)', 'woocommerce-subscriptions' ), get_woocommerce_currency_symbol() ),
|
|
'placeholder' => // translators: %s the formatted example price value.
|
|
esc_attr( sprintf( _x( 'e.g. %s', 'example price', 'woocommerce-subscriptions' ), wc_format_localized_price( '5.90' ) ) ),
|
|
'description' => __( 'Optionally include an amount to be charged at the outset of the subscription. The sign-up fee will be charged immediately, even if the product has a free trial or the payment dates are synced.', 'woocommerce-subscriptions' ),
|
|
'desc_tip' => true,
|
|
'type' => 'text',
|
|
'data_type' => 'price',
|
|
'custom_attributes' => array(
|
|
'step' => 'any',
|
|
'min' => '0',
|
|
),
|
|
)
|
|
);
|
|
|
|
// Trial Length
|
|
?>
|
|
<p class="form-field _subscription_trial_length_field">
|
|
<label for="_subscription_trial_length"><?php esc_html_e( 'Free trial', 'woocommerce-subscriptions' ); ?></label>
|
|
<span class="wrap">
|
|
<input type="text" id="_subscription_trial_length" name="_subscription_trial_length" class="wc_input_subscription_trial_length" value="<?php echo esc_attr( $chosen_trial_length ); ?>" />
|
|
<label for="_subscription_trial_period" class="wcs_hidden_label"><?php esc_html_e( 'Subscription Trial Period', 'woocommerce-subscriptions' ); ?></label>
|
|
<select id="_subscription_trial_period" name="_subscription_trial_period" class="wc_input_subscription_trial_period last wc-enhanced-select" >
|
|
<?php foreach ( wcs_get_available_time_periods() as $value => $label ) { ?>
|
|
<option value="<?php echo esc_attr( $value ); ?>" <?php selected( $value, $chosen_trial_period, true ); ?>><?php echo esc_html( $label ); ?></option>
|
|
<?php } ?>
|
|
</select>
|
|
</span>
|
|
<?php
|
|
// @phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
|
|
echo wcs_help_tip( $trial_tooltip );
|
|
?>
|
|
</p>
|
|
<?php
|
|
|
|
// Maybe show gifting options. The method_exists check is required for cases where the standalone Gifting
|
|
// extension is active (in which case, a different version of WCSG_Admin will be loaded).
|
|
if ( method_exists( WCSG_Admin::class, 'is_gifting_enabled' ) && WCSG_Admin::is_gifting_enabled() ) {
|
|
$product_gifting = WC_Subscriptions_Product::get_gifting( $post->ID );
|
|
$is_following_gifting_global_setting = empty( $product_gifting );
|
|
|
|
woocommerce_wp_select(
|
|
array(
|
|
'id' => '_subscription_gifting',
|
|
'class' => 'select short wc-enhanced-select',
|
|
'wrapper_class' => '_subscription_gifting_field' . ( ! $is_following_gifting_global_setting ? ' overriding-store-settings' : '' ),
|
|
'label' => __( 'Gifting', 'woocommerce-subscriptions' ),
|
|
'value' => $product_gifting,
|
|
'options' => array(
|
|
'' => WCSG_Admin::get_gifting_option_text(),
|
|
'enabled' => __( 'Enabled', 'woocommerce-subscriptions' ),
|
|
'disabled' => __( 'Disabled', 'woocommerce-subscriptions' ),
|
|
),
|
|
'desc_tip' => true,
|
|
'description' => __( 'Allow shoppers to purchase a subscription as a gift.', 'woocommerce-subscriptions' ),
|
|
)
|
|
);
|
|
|
|
if ( ! $is_following_gifting_global_setting ) {
|
|
WCSG_Admin::get_gifting_global_override_text();
|
|
}
|
|
}
|
|
|
|
do_action( 'woocommerce_subscriptions_product_options_pricing' );
|
|
|
|
wp_nonce_field( 'wcs_subscription_meta', '_wcsnonce' );
|
|
|
|
echo '</div>';
|
|
echo '<div class="show_if_subscription clear"></div>';
|
|
}
|
|
|
|
/**
|
|
* Output subscription shipping options on the "Edit Product" admin screen
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
|
|
*/
|
|
public static function subscription_shipping_fields() {
|
|
global $post;
|
|
|
|
$needs_html_fix = 'woocommerce_product_options_shipping' === current_filter();
|
|
|
|
// Old hook is nested and requires invalid html markup to be compatible with other plugins.
|
|
if ( $needs_html_fix ) {
|
|
echo '</div>';
|
|
}
|
|
|
|
echo '<div class="options_group subscription_one_time_shipping show_if_subscription show_if_variable-subscription hidden">';
|
|
|
|
// Only one Subscription per customer
|
|
woocommerce_wp_checkbox(
|
|
array(
|
|
'id' => '_subscription_one_time_shipping',
|
|
'label' => __( 'One time shipping', 'woocommerce-subscriptions' ),
|
|
'description' => __( 'Shipping for subscription products is normally charged on the initial order and all renewal orders. Enable this to only charge shipping once on the initial order. Note: for this setting to be enabled the subscription must not have a free trial or a synced renewal date.', 'woocommerce-subscriptions' ),
|
|
'desc_tip' => true,
|
|
)
|
|
);
|
|
|
|
do_action( 'woocommerce_subscriptions_product_options_shipping' );
|
|
|
|
if ( ! $needs_html_fix ) {
|
|
echo '</div>';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Output advanced subscription options on the "Edit Product" admin screen
|
|
* @deprecated 1.0.0 - Migrated from WooCommerce Subscriptions v2.1
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.3.5
|
|
*/
|
|
public static function subscription_advanced_fields() {
|
|
_deprecated_function( __METHOD__, '2.1', 'WCS_Limiter::admin_edit_product_fields()' );
|
|
}
|
|
|
|
/**
|
|
* Output the subscription specific pricing fields on the "Edit Product" admin page.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.3
|
|
*/
|
|
public static function variable_subscription_pricing_fields( $loop, $variation_data, $variation ) {
|
|
global $thepostid;
|
|
|
|
// When called via Ajax
|
|
if ( ! function_exists( 'woocommerce_wp_text_input' ) ) {
|
|
require_once WC()->plugin_path() . '/admin/post-types/writepanels/writepanels-init.php';
|
|
}
|
|
|
|
if ( ! isset( $thepostid ) ) {
|
|
$thepostid = $variation->post_parent;
|
|
}
|
|
|
|
$variation_product = wc_get_product( $variation );
|
|
$billing_period = WC_Subscriptions_Product::get_period( $variation_product );
|
|
|
|
if ( empty( $billing_period ) ) {
|
|
$billing_period = 'month';
|
|
}
|
|
|
|
include WC_Subscriptions_Plugin::instance()->get_plugin_directory( 'templates/admin/html-variation-price.php' );
|
|
|
|
wp_nonce_field( 'wcs_subscription_variations', '_wcsnonce_save_variations', false );
|
|
|
|
do_action( 'woocommerce_variable_subscription_pricing', $loop, $variation_data, $variation );
|
|
}
|
|
|
|
/**
|
|
* Output extra options in the Bulk Edit select box for editing Subscription terms.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.3
|
|
*/
|
|
public static function variable_subscription_bulk_edit_actions() {
|
|
global $post;
|
|
|
|
if ( WC_Subscriptions_Product::is_subscription( $post->ID ) ) :
|
|
?>
|
|
<optgroup label="<?php esc_attr_e( 'Subscription pricing', 'woocommerce-subscriptions' ); ?>">
|
|
<option value="variable_subscription_sign_up_fee"><?php esc_html_e( 'Subscription sign-up fee', 'woocommerce-subscriptions' ); ?></option>
|
|
<option value="variable_subscription_period_interval"><?php esc_html_e( 'Subscription billing interval', 'woocommerce-subscriptions' ); ?></option>
|
|
<option value="variable_subscription_period"><?php esc_html_e( 'Subscription period', 'woocommerce-subscriptions' ); ?></option>
|
|
<option value="variable_subscription_length"><?php esc_html_e( 'Stop renewing after', 'woocommerce-subscriptions' ); ?></option>
|
|
<option value="variable_subscription_trial_length"><?php esc_html_e( 'Free trial length', 'woocommerce-subscriptions' ); ?></option>
|
|
<option value="variable_subscription_trial_period"><?php esc_html_e( 'Free trial period', 'woocommerce-subscriptions' ); ?></option>
|
|
</optgroup>
|
|
<?php
|
|
endif;
|
|
}
|
|
|
|
/**
|
|
* Save meta data for simple subscription product type when the "Edit Product" form is submitted.
|
|
*
|
|
* @param int $post_id The ID of the post being saved.
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.0
|
|
*/
|
|
public static function save_subscription_meta( $post_id ) {
|
|
|
|
if ( empty( $_POST['_wcsnonce'] ) || ! wp_verify_nonce( wc_clean( wp_unslash( $_POST['_wcsnonce'] ) ), 'wcs_subscription_meta' ) || false === self::is_subscription_product_save_request( $post_id, apply_filters( 'woocommerce_subscription_product_types', array( WC_Subscriptions_Core_Plugin::instance()->get_product_type_name() ) ) ) ) {
|
|
return;
|
|
}
|
|
|
|
$subscription_price = isset( $_REQUEST['_subscription_price'] ) ? wc_format_decimal( $_REQUEST['_subscription_price'] ) : '';
|
|
$sale_price = wc_format_decimal( $_REQUEST['_sale_price'] );
|
|
|
|
update_post_meta( $post_id, '_subscription_price', $subscription_price );
|
|
|
|
// Set sale details - these are ignored by WC core for the subscription product type
|
|
update_post_meta( $post_id, '_regular_price', $subscription_price );
|
|
update_post_meta( $post_id, '_sale_price', $sale_price );
|
|
|
|
$site_offset = wc_timezone_offset();
|
|
|
|
// Fetch the timestamps in UTC time to check if the product is currently on sale.
|
|
$date_from = ! empty( $_POST['_sale_price_dates_from'] ) ? wcs_date_to_time( gmdate( 'Y-m-d 00:00:00', wcs_strtotime_dark_knight( wc_clean( wp_unslash( $_POST['_sale_price_dates_from'] ) ) ) ) ) - $site_offset : '';
|
|
$date_to = ! empty( $_POST['_sale_price_dates_to'] ) ? wcs_date_to_time( gmdate( 'Y-m-d 23:59:59', wcs_strtotime_dark_knight( wc_clean( wp_unslash( $_POST['_sale_price_dates_to'] ) ) ) ) ) - $site_offset : '';
|
|
|
|
$now = gmdate( 'U' );
|
|
|
|
if ( ! empty( $date_to ) && empty( $date_from ) ) {
|
|
$date_from = $now;
|
|
}
|
|
|
|
// Update price if on sale
|
|
if ( '' !== $sale_price && ( ( empty( $date_to ) && empty( $date_from ) ) || ( $date_from < $now && ( empty( $date_to ) || $date_to > $now ) ) ) ) {
|
|
$price = $sale_price;
|
|
} else {
|
|
$price = $subscription_price;
|
|
}
|
|
|
|
update_post_meta( $post_id, '_price', stripslashes( $price ) );
|
|
|
|
// Make sure trial period is within allowable range
|
|
$subscription_ranges = wcs_get_subscription_ranges();
|
|
|
|
$max_trial_length = ! empty( $_POST['_subscription_trial_period'] ) ? count( $subscription_ranges[ $_POST['_subscription_trial_period'] ] ) - 1 : 0;
|
|
|
|
$_POST['_subscription_trial_length'] = ! empty( $_POST['_subscription_trial_length'] ) ? absint( $_POST['_subscription_trial_length'] ) : 0;
|
|
|
|
if ( $_POST['_subscription_trial_length'] > $max_trial_length ) {
|
|
$_POST['_subscription_trial_length'] = $max_trial_length;
|
|
}
|
|
|
|
update_post_meta( $post_id, '_subscription_trial_length', wc_clean( wp_unslash( $_POST['_subscription_trial_length'] ) ) );
|
|
|
|
$_REQUEST['_subscription_sign_up_fee'] = wc_format_decimal( $_REQUEST['_subscription_sign_up_fee'] );
|
|
$_REQUEST['_subscription_one_time_shipping'] = isset( $_REQUEST['_subscription_one_time_shipping'] ) ? 'yes' : 'no';
|
|
|
|
$subscription_fields = array(
|
|
'_subscription_sign_up_fee',
|
|
'_subscription_period',
|
|
'_subscription_period_interval',
|
|
'_subscription_length',
|
|
'_subscription_trial_period',
|
|
'_subscription_limit',
|
|
'_subscription_one_time_shipping',
|
|
'_subscription_gifting',
|
|
);
|
|
|
|
foreach ( $subscription_fields as $field_name ) {
|
|
if ( isset( $_REQUEST[ $field_name ] ) ) {
|
|
update_post_meta( $post_id, $field_name, stripslashes( $_REQUEST[ $field_name ] ) );
|
|
}
|
|
}
|
|
|
|
// To prevent running this function on multiple save_post triggered events per update. Similar to WC_Admin_Meta_Boxes:$saved_meta_boxes implementation.
|
|
self::$saved_product_meta = true;
|
|
}
|
|
|
|
/**
|
|
* Save meta data for variable subscription product type when the "Edit Product" form is submitted.
|
|
*
|
|
* @param int $post_id The ID of the post being saved.
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
|
|
*/
|
|
public static function save_variable_subscription_meta( $post_id ) {
|
|
|
|
if ( empty( $_POST['_wcsnonce'] ) || ! wp_verify_nonce( wc_clean( wp_unslash( $_POST['_wcsnonce'] ) ), 'wcs_subscription_meta' ) || false === self::is_subscription_product_save_request( $post_id, apply_filters( 'woocommerce_subscription_variable_product_types', array( 'variable-subscription' ) ) ) ) {
|
|
return;
|
|
}
|
|
|
|
if ( isset( $_REQUEST['_subscription_limit'] ) ) {
|
|
update_post_meta( $post_id, '_subscription_limit', stripslashes( $_REQUEST['_subscription_limit'] ) );
|
|
}
|
|
|
|
update_post_meta( $post_id, '_subscription_one_time_shipping', stripslashes( isset( $_REQUEST['_subscription_one_time_shipping'] ) ? 'yes' : 'no' ) );
|
|
|
|
// To prevent running this function on multiple save_post triggered events per update. Similar to WC_Admin_Meta_Boxes:$saved_meta_boxes implementation.
|
|
self::$saved_product_meta = true;
|
|
}
|
|
|
|
/**
|
|
* Calculate and set a simple subscription's prices when edited via the bulk edit
|
|
*
|
|
* @param object $product An instance of a WC_Product_* object.
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.3.9
|
|
*/
|
|
public static function bulk_edit_save_subscription_meta( $product ) {
|
|
|
|
if ( ! $product->is_type( 'subscription' ) ) {
|
|
return;
|
|
}
|
|
|
|
$price_changed = false;
|
|
|
|
$old_regular_price = $product->get_regular_price();
|
|
$old_sale_price = $product->get_sale_price();
|
|
|
|
if ( ! empty( $_REQUEST['change_regular_price'] ) ) {
|
|
|
|
$change_regular_price = absint( $_REQUEST['change_regular_price'] );
|
|
$regular_price = esc_attr( stripslashes( $_REQUEST['_regular_price'] ) );
|
|
|
|
switch ( $change_regular_price ) {
|
|
case 1:
|
|
$new_price = $regular_price;
|
|
break;
|
|
case 2:
|
|
if ( strstr( $regular_price, '%' ) ) {
|
|
$percent = (float) str_replace( '%', '', $regular_price ) / 100;
|
|
$new_price = $old_regular_price + ( $old_regular_price * $percent );
|
|
} else {
|
|
$new_price = $old_regular_price + $regular_price;
|
|
}
|
|
break;
|
|
case 3:
|
|
if ( strstr( $regular_price, '%' ) ) {
|
|
$percent = (float) str_replace( '%', '', $regular_price ) / 100;
|
|
$new_price = $old_regular_price - ( $old_regular_price * $percent );
|
|
} else {
|
|
$new_price = $old_regular_price - $regular_price;
|
|
}
|
|
break;
|
|
}
|
|
|
|
if ( isset( $new_price ) && $new_price != $old_regular_price ) {
|
|
$price_changed = true;
|
|
wcs_set_objects_property( $product, 'regular_price', $new_price );
|
|
wcs_set_objects_property( $product, 'subscription_price', $new_price );
|
|
}
|
|
}
|
|
|
|
if ( ! empty( $_REQUEST['change_sale_price'] ) ) {
|
|
|
|
$change_sale_price = absint( $_REQUEST['change_sale_price'] );
|
|
$sale_price = esc_attr( stripslashes( $_REQUEST['_sale_price'] ) );
|
|
|
|
switch ( $change_sale_price ) {
|
|
case 1:
|
|
$new_price = $sale_price;
|
|
break;
|
|
case 2:
|
|
if ( strstr( $sale_price, '%' ) ) {
|
|
$percent = (float) str_replace( '%', '', $sale_price ) / 100;
|
|
$new_price = $old_sale_price + ( $old_sale_price * $percent );
|
|
} else {
|
|
$new_price = $old_sale_price + $sale_price;
|
|
}
|
|
break;
|
|
case 3:
|
|
if ( strstr( $sale_price, '%' ) ) {
|
|
$percent = (float) str_replace( '%', '', $sale_price ) / 100;
|
|
$new_price = $old_sale_price - ( $old_sale_price * $percent );
|
|
} else {
|
|
$new_price = $old_sale_price - $sale_price;
|
|
}
|
|
break;
|
|
case 4:
|
|
if ( strstr( $sale_price, '%' ) ) {
|
|
$percent = (float) str_replace( '%', '', $sale_price ) / 100;
|
|
$new_price = $product->get_regular_price() - ( $product->get_regular_price() * $percent );
|
|
} else {
|
|
$new_price = $product->get_regular_price() - $sale_price;
|
|
}
|
|
break;
|
|
}
|
|
|
|
if ( isset( $new_price ) && $new_price != $old_sale_price ) {
|
|
$price_changed = true;
|
|
wcs_set_objects_property( $product, 'sale_price', $new_price );
|
|
}
|
|
}
|
|
|
|
if ( $price_changed ) {
|
|
wcs_set_objects_property( $product, 'sale_price_dates_from', '' );
|
|
wcs_set_objects_property( $product, 'sale_price_dates_to', '' );
|
|
|
|
if ( $product->get_regular_price() < $product->get_sale_price() ) {
|
|
wcs_set_objects_property( $product, 'sale_price', '' );
|
|
}
|
|
|
|
if ( $product->get_sale_price() ) {
|
|
wcs_set_objects_property( $product, 'price', $product->get_sale_price() );
|
|
} else {
|
|
wcs_set_objects_property( $product, 'price', $product->get_regular_price() );
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Save a variable subscription's details when the edit product page is submitted for a variable
|
|
* subscription product type (or the bulk edit product is saved).
|
|
*
|
|
* @param int $post_id ID of the parent WC_Product_Variable_Subscription
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.3
|
|
*/
|
|
public static function process_product_meta_variable_subscription( $post_id ) {
|
|
|
|
if ( ! WC_Subscriptions_Product::is_subscription( $post_id ) || empty( $_POST['_wcsnonce'] ) || ! wp_verify_nonce( wc_clean( wp_unslash( $_POST['_wcsnonce'] ) ), 'wcs_subscription_meta' ) ) {
|
|
return;
|
|
}
|
|
|
|
// Make sure WooCommerce calculates correct prices
|
|
$_POST['variable_regular_price'] = isset( $_POST['variable_subscription_price'] ) ? wc_clean( wp_unslash( $_POST['variable_subscription_price'] ) ) : 0;
|
|
|
|
// Sync the min variation price
|
|
if ( wcs_is_woocommerce_pre( '3.0' ) ) {
|
|
$variable_subscription = wc_get_product( $post_id );
|
|
$variable_subscription->variable_product_sync();
|
|
} else {
|
|
WC_Product_Variable::sync( $post_id );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Save meta info for subscription variations
|
|
*
|
|
* @param int $variation_id
|
|
* @param int $index
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
|
|
*/
|
|
public static function save_product_variation( $variation_id, $index ) {
|
|
|
|
if ( ! WC_Subscriptions_Product::is_subscription( $variation_id ) || empty( $_POST['_wcsnonce_save_variations'] ) || ! wp_verify_nonce( wc_clean( wp_unslash( $_POST['_wcsnonce_save_variations'] ) ), 'wcs_subscription_variations' ) ) {
|
|
return;
|
|
}
|
|
|
|
if ( isset( $_POST['variable_subscription_sign_up_fee'][ $index ] ) ) {
|
|
$subscription_sign_up_fee = wc_format_decimal( $_POST['variable_subscription_sign_up_fee'][ $index ] );
|
|
update_post_meta( $variation_id, '_subscription_sign_up_fee', $subscription_sign_up_fee );
|
|
}
|
|
|
|
if ( isset( $_POST['variable_subscription_price'][ $index ] ) ) {
|
|
$subscription_price = wc_format_decimal( $_POST['variable_subscription_price'][ $index ] );
|
|
update_post_meta( $variation_id, '_subscription_price', $subscription_price );
|
|
update_post_meta( $variation_id, '_regular_price', $subscription_price );
|
|
}
|
|
|
|
// Make sure trial period is within allowable range
|
|
$subscription_ranges = wcs_get_subscription_ranges();
|
|
$max_trial_length = ! empty( $_POST['variable_subscription_trial_period'][ $index ] ) ? count( $subscription_ranges[ $_POST['variable_subscription_trial_period'][ $index ] ] ) - 1 : 0;
|
|
|
|
$_POST['variable_subscription_trial_length'][ $index ] = ! empty( $_POST['variable_subscription_trial_length'][ $index ] ) ? absint( $_POST['variable_subscription_trial_length'][ $index ] ) : 0;
|
|
|
|
if ( $_POST['variable_subscription_trial_length'][ $index ] > $max_trial_length ) {
|
|
$_POST['variable_subscription_trial_length'][ $index ] = $max_trial_length;
|
|
}
|
|
|
|
// Work around a WPML bug which means 'variable_subscription_trial_period' is not set when using "Edit Product" as the product translation interface
|
|
if ( $_POST['variable_subscription_trial_length'][ $index ] < 0 ) {
|
|
$_POST['variable_subscription_trial_length'][ $index ] = 0;
|
|
}
|
|
|
|
$subscription_fields = array(
|
|
'_subscription_period',
|
|
'_subscription_period_interval',
|
|
'_subscription_length',
|
|
'_subscription_trial_period',
|
|
'_subscription_trial_length',
|
|
'_subscription_gifting',
|
|
);
|
|
|
|
foreach ( $subscription_fields as $field_name ) {
|
|
if ( isset( $_POST[ 'variable' . $field_name ][ $index ] ) ) {
|
|
update_post_meta( $variation_id, $field_name, wc_clean( $_POST[ 'variable' . $field_name ][ $index ] ) );
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Make sure when saving a subscription via the admin to activate it, it has a valid customer set on it.
|
|
*
|
|
* When you click "Add New Subscription", the status is already going to be pending to begin with. This will prevent
|
|
* changing the status to anything else besides pending if no customer is specified, or the customer specified is
|
|
* not a valid WP_User.
|
|
*
|
|
* Hooked into `woocommerce_subscription_pre_update_status`
|
|
*
|
|
* @param string $old_status Previous status of the subscription in update_status
|
|
* @param string $new_status New status of the subscription in update_status
|
|
* @param WC_Subscription $subscription The subscription being savedf
|
|
*
|
|
* @throws Exception in case there was no user found / there's no customer attached to it
|
|
*/
|
|
public static function check_customer_is_set( $old_status, $new_status, $subscription ) {
|
|
global $post;
|
|
|
|
if ( is_admin() && 'active' == $new_status && isset( $_POST['woocommerce_meta_nonce'] ) && wp_verify_nonce( wc_clean( wp_unslash( $_POST['woocommerce_meta_nonce'] ) ), 'woocommerce_save_data' ) && isset( $_POST['customer_user'] ) && ! empty( $post ) && 'shop_subscription' === $post->post_type ) {
|
|
|
|
$user = new WP_User( absint( $_POST['customer_user'] ) );
|
|
|
|
if ( 0 === $user->ID ) {
|
|
// translators: %s: subscription status.
|
|
throw new Exception( sprintf( __( 'Unable to change subscription status to "%s". Please assign a customer to the subscription to activate it.', 'woocommerce-subscriptions' ), $new_status ) );
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Set default values for subscription dropdown fields when bulk adding variations to fix issue #1342
|
|
*
|
|
* @param int $variation_id ID the post_id of the variation being added
|
|
*/
|
|
public static function set_variation_meta_defaults_on_bulk_add( $variation_id ) {
|
|
|
|
if ( ! empty( $variation_id ) ) {
|
|
update_post_meta( $variation_id, '_subscription_period', 'month' );
|
|
update_post_meta( $variation_id, '_subscription_period_interval', '1' );
|
|
update_post_meta( $variation_id, '_subscription_length', '0' );
|
|
update_post_meta( $variation_id, '_subscription_trial_period', 'month' );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Adds all necessary admin styles.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.0
|
|
*/
|
|
public static function enqueue_styles_scripts() {
|
|
global $post;
|
|
|
|
// Get admin screen ID.
|
|
$screen = get_current_screen();
|
|
|
|
$is_woocommerce_screen = in_array(
|
|
$screen->id,
|
|
[
|
|
'product',
|
|
'edit-shop_order',
|
|
'shop_order',
|
|
'edit-shop_subscription',
|
|
'shop_subscription',
|
|
'users',
|
|
'woocommerce_page_wc-settings',
|
|
'woocommerce_page_wc-orders',
|
|
wcs_get_page_screen_id( 'shop_subscription' ),
|
|
],
|
|
true
|
|
);
|
|
|
|
if ( $is_woocommerce_screen ) {
|
|
$dependencies = array( 'jquery' );
|
|
|
|
$woocommerce_admin_script_handle = 'wc-admin-meta-boxes';
|
|
$trashing_subscription_order_warning = __( 'Trashing this order will also trash the subscriptions purchased with the order.', 'woocommerce-subscriptions' );
|
|
|
|
if ( $screen->id == 'product' ) {
|
|
$dependencies[] = $woocommerce_admin_script_handle;
|
|
$dependencies[] = 'wc-admin-product-meta-boxes';
|
|
$dependencies[] = 'wc-admin-variation-meta-boxes';
|
|
|
|
$script_params = array(
|
|
'productType' => WC_Subscriptions_Core_Plugin::instance()->get_product_type_name(),
|
|
'trialPeriodSingular' => wcs_get_available_time_periods(),
|
|
'trialPeriodPlurals' => wcs_get_available_time_periods( 'plural' ),
|
|
'subscriptionLengths' => wcs_get_subscription_ranges(),
|
|
'trialTooLongMessages' => self::get_trial_period_validation_message( 'separate' ),
|
|
'bulkEditPeriodMessage' => __( 'Enter the new period, either day, week, month or year:', 'woocommerce-subscriptions' ),
|
|
'bulkEditLengthMessage' => __( 'Enter a new length (e.g. 5):', 'woocommerce-subscriptions' ),
|
|
'bulkEditIntervalhMessage' => __( 'Enter a new interval as a single number (e.g. to charge every 2nd month, enter 2):', 'woocommerce-subscriptions' ),
|
|
'bulkDeleteOptionLabel' => __( 'Delete all variations without a subscription', 'woocommerce-subscriptions' ),
|
|
'oneTimeShippingCheckNonce' => wp_create_nonce( 'one_time_shipping' ),
|
|
'productHasSubscriptions' => ! wcs_is_large_site() && wcs_get_subscriptions_for_product( $post->ID, 'ids', array( 'limit' => 1 ) ) ? 'yes' : 'no',
|
|
'productTypeWarning' => self::get_change_product_type_warning(),
|
|
'isLargeSite' => wcs_is_large_site(),
|
|
'nonce' => wp_create_nonce( 'wc_subscriptions_admin' ),
|
|
'variationDeleteErrorMessage' => __( 'An error occurred determining if that variation can be deleted. Please try again.', 'woocommerce-subscriptions' ),
|
|
'variationDeleteFailMessage' => __( 'That 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' ),
|
|
|
|
);
|
|
} elseif ( 'edit-shop_order' == $screen->id ) {
|
|
$script_params = array(
|
|
'bulkTrashWarning' => __( "You are about to trash one or more orders which contain a subscription.\n\nTrashing the orders will also trash the subscriptions purchased with these orders.", 'woocommerce-subscriptions' ),
|
|
'trashWarning' => $trashing_subscription_order_warning,
|
|
);
|
|
} elseif ( 'shop_order' == $screen->id ) {
|
|
$dependencies[] = $woocommerce_admin_script_handle;
|
|
$dependencies[] = 'wc-admin-order-meta-boxes';
|
|
$script_params = array(
|
|
'trashWarning' => $trashing_subscription_order_warning,
|
|
'changeMetaWarning' => __( "WARNING: Bad things are about to happen!\n\nThe payment gateway used to purchase this subscription does not support modifying a subscription's details.\n\nChanges to the billing period, recurring discount, recurring tax or recurring total may not be reflected in the amount charged by the payment gateway.", 'woocommerce-subscriptions' ),
|
|
'removeItemWarning' => __( 'You are deleting a subscription item. You will also need to manually cancel and trash the subscription on the Manage Subscriptions screen.', 'woocommerce-subscriptions' ),
|
|
'roundAtSubtotal' => esc_attr( get_option( 'woocommerce_tax_round_at_subtotal' ) ),
|
|
'EditOrderNonce' => wp_create_nonce( 'woocommerce-subscriptions' ),
|
|
'postId' => $post->ID,
|
|
);
|
|
} elseif ( 'users' == $screen->id ) {
|
|
$script_params = array(
|
|
'deleteUserWarning' => __( "Warning: Deleting a user will also delete the user's subscriptions. The user's orders will remain but be reassigned to the 'Guest' user.\n\nDo you want to continue to delete this user and any associated subscriptions?", 'woocommerce-subscriptions' ),
|
|
);
|
|
} elseif ( 'woocommerce_page_wc-settings' === $screen->id ) {
|
|
$script_params = array(
|
|
'enablePayPalWarning' => __( 'PayPal Standard has a number of limitations and does not support all subscription features.', 'woocommerce-subscriptions' ) . "\n\n" . __( 'Because of this, it is not recommended as a payment method for Subscriptions unless it is the only available option for your country.', 'woocommerce-subscriptions' ),
|
|
);
|
|
} elseif ( in_array( $screen->id, [ wcs_get_page_screen_id( 'shop_subscription' ), 'edit-shop_subscription' ], true ) ) {
|
|
$script_params['i18n_remove_personal_data_notice'] = __( 'This action cannot be reversed. Are you sure you wish to erase personal data from the selected subscriptions?', 'woocommerce-subscriptions' );
|
|
}
|
|
|
|
$script_params['ajaxLoaderImage'] = WC()->plugin_url() . '/assets/images/ajax-loader.gif';
|
|
$script_params['ajaxUrl'] = admin_url( 'admin-ajax.php' );
|
|
$script_params['isWCPre24'] = var_export( wcs_is_woocommerce_pre( '2.4' ), true );
|
|
|
|
wp_enqueue_script( 'woocommerce_subscriptions_admin', WC_Subscriptions_Core_Plugin::instance()->get_subscriptions_core_directory_url( 'assets/js/admin/admin.js' ), $dependencies, filemtime( dirname( WC_Subscriptions::$plugin_file ) . '/assets/js/admin/admin.js' ) );
|
|
wp_localize_script( 'woocommerce_subscriptions_admin', 'WCSubscriptions', apply_filters( 'woocommerce_subscriptions_admin_script_parameters', $script_params ) );
|
|
|
|
// Maybe add the pointers for first timers
|
|
if ( isset( $_GET['subscription_pointers'] ) && self::show_user_pointers() ) {
|
|
|
|
$dependencies[] = 'wp-pointer';
|
|
|
|
$pointer_script_params = array(
|
|
// translators: placeholders are for HTML tags. They are 1$: "<h3>", 2$: "</h3>", 3$: "<p>", 4$: "<em>", 5$: "</em>", 6$: "<em>", 7$: "</em>", 8$: "</p>"
|
|
'typePointerContent' => sprintf( _x( '%1$sChoose Subscription%2$s%3$sThe WooCommerce Subscriptions extension adds two new subscription product types - %4$sSimple subscription%5$s and %6$sVariable subscription%7$s.%8$s', 'used in admin pointer script params in javascript as type pointer content', 'woocommerce-subscriptions' ), '<h3>', '</h3>', '<p>', '<em>', '</em>', '<em>', '</em>', '</p>' ),
|
|
// translators: placeholders are for HTML tags. They are 1$: "<h3>", 2$: "</h3>", 3$: "<p>", 4$: "</p>"
|
|
'pricePointerContent' => sprintf( _x( '%1$sSet a Price%2$s%3$sSubscription prices are a little different to other product prices. For a subscription, you can set a billing period, length, sign-up fee and free trial.%4$s', 'used in admin pointer script params in javascript as price pointer content', 'woocommerce-subscriptions' ), '<h3>', '</h3>', '<p>', '</p>' ),
|
|
);
|
|
|
|
wp_enqueue_script( 'woocommerce_subscriptions_admin_pointers', WC_Subscriptions_Core_Plugin::instance()->get_subscriptions_core_directory_url( 'assets/js/admin/admin-pointers.js' ), $dependencies, WC_Subscriptions_Core_Plugin::instance()->get_library_version(), true );
|
|
|
|
wp_localize_script( 'woocommerce_subscriptions_admin_pointers', 'WCSPointers', apply_filters( 'woocommerce_subscriptions_admin_pointer_script_parameters', $pointer_script_params ) );
|
|
|
|
wp_enqueue_style( 'wp-pointer' );
|
|
}
|
|
}
|
|
|
|
if ( $is_woocommerce_screen || 'edit-product' == $screen->id || ( isset( $_GET['page'], $_GET['tab'] ) && 'wc-reports' === $_GET['page'] && 'subscriptions' === $_GET['tab'] ) ) {
|
|
wp_enqueue_style( 'woocommerce_admin_styles', WC()->plugin_url() . '/assets/css/admin.css', [ 'wc-components' ], WC_Subscriptions::$version );
|
|
wp_enqueue_style( 'woocommerce_subscriptions_admin', WC_Subscriptions_Core_Plugin::instance()->get_subscriptions_core_directory_url( 'assets/css/admin.css' ), array( 'woocommerce_admin_styles' ), WC_Subscriptions::$version );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Add the "Active Subscriber?" column to the User's admin table
|
|
*/
|
|
public static function add_user_columns( $columns ) {
|
|
|
|
if ( current_user_can( 'manage_woocommerce' ) ) {
|
|
// Move Active Subscriber before Orders for aesthetics
|
|
$last_column = array_slice( $columns, -1, 1, true );
|
|
array_pop( $columns );
|
|
$columns['woocommerce_active_subscriber'] = __( 'Active subscriber?', 'woocommerce-subscriptions' );
|
|
$columns += $last_column;
|
|
}
|
|
|
|
return $columns;
|
|
}
|
|
|
|
/**
|
|
* Hooked to the users table to display a check mark if a given user has an active subscription.
|
|
*
|
|
* @param string $value The string to output in the column specified with $column_name
|
|
* @param string $column_name The string key for the current column in an admin table
|
|
* @param int $user_id The ID of the user to which this row relates
|
|
* @return string $value A check mark if the column is the active_subscriber column and the user has an active subscription.
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.0
|
|
*/
|
|
public static function user_column_values( $value, $column_name, $user_id ) {
|
|
|
|
if ( 'woocommerce_active_subscriber' == $column_name ) {
|
|
if ( wcs_user_has_subscription( $user_id, '', 'active' ) ) {
|
|
$value = '<div class="active-subscriber"></div>';
|
|
} else {
|
|
$value = '<div class="inactive-subscriber">-</div>';
|
|
}
|
|
}
|
|
|
|
return $value;
|
|
}
|
|
|
|
|
|
/**
|
|
* Outputs the Subscription Management admin page with a sortable @see WC_Subscriptions_List_Table used to
|
|
* display all the subscriptions that have been purchased.
|
|
*
|
|
* @uses WC_Subscriptions_List_Table
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.0
|
|
*/
|
|
public static function subscriptions_management_page() {
|
|
|
|
$subscriptions_table = self::get_subscriptions_list_table();
|
|
$subscriptions_table->prepare_items();
|
|
?>
|
|
<div class="wrap">
|
|
<div id="icon-woocommerce" class="icon32-woocommerce-users icon32"><br/></div>
|
|
<h2><?php esc_html_e( 'Manage Subscriptions', 'woocommerce-subscriptions' ); ?></h2>
|
|
<?php $subscriptions_table->messages(); ?>
|
|
<?php $subscriptions_table->views(); ?>
|
|
<form id="subscriptions-search" action="" method="get"><?php // Don't send all the subscription meta across ?>
|
|
<?php $subscriptions_table->search_box( __( 'Search Subscriptions', 'woocommerce-subscriptions' ), 'subscription' ); ?>
|
|
<input type="hidden" name="page" value="subscriptions" />
|
|
<?php if ( isset( $_REQUEST['status'] ) ) { ?>
|
|
<input type="hidden" name="status" value="<?php echo esc_attr( wc_clean( wp_unslash( $_REQUEST['status'] ) ) ); ?>" />
|
|
<?php } ?>
|
|
</form>
|
|
<form id="subscriptions-filter" action="" method="get">
|
|
<?php $subscriptions_table->display(); ?>
|
|
</form>
|
|
</div>
|
|
<?php
|
|
}
|
|
|
|
/**
|
|
* Outputs the screen options on the Subscription Management admin page.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.3.1
|
|
*/
|
|
public static function add_manage_subscriptions_screen_options() {
|
|
add_screen_option(
|
|
'per_page',
|
|
array(
|
|
'label' => __( 'Subscriptions', 'woocommerce-subscriptions' ),
|
|
'default' => 10,
|
|
'option' => self::$option_prefix . '_admin_per_page',
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Sets the correct value for screen options on the Subscription Management admin page.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.3.1
|
|
*/
|
|
public static function set_manage_subscriptions_screen_option( $status, $option, $value ) {
|
|
|
|
if ( self::$option_prefix . '_admin_per_page' == $option ) {
|
|
return $value;
|
|
}
|
|
|
|
return $status;
|
|
}
|
|
|
|
/**
|
|
* Returns the columns for the Manage Subscriptions table, specifically used for adding the
|
|
* show/hide column screen options.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.3.1
|
|
*/
|
|
public static function get_subscription_table_columns( $columns ) {
|
|
|
|
$subscriptions_table = self::get_subscriptions_list_table();
|
|
|
|
return array_merge( $subscriptions_table->get_columns(), $columns );
|
|
}
|
|
|
|
/**
|
|
* Returns the columns for the Manage Subscriptions table, specifically used for adding the
|
|
* show/hide column screen options.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.3.1
|
|
*/
|
|
public static function get_subscriptions_list_table() {
|
|
|
|
if ( ! isset( self::$subscriptions_list_table ) ) {
|
|
// @phpstan-ignore class.notFound
|
|
self::$subscriptions_list_table = new WC_Subscriptions_List_Table();
|
|
}
|
|
|
|
return self::$subscriptions_list_table;
|
|
}
|
|
|
|
/**
|
|
* Uses the WooCommerce options API to save settings via the @see woocommerce_update_options() function.
|
|
*
|
|
* @uses woocommerce_update_options()
|
|
* @uses self::get_settings()
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.0
|
|
*/
|
|
public static function update_subscription_settings() {
|
|
|
|
if ( empty( $_POST['_wcsnonce'] ) || ! wp_verify_nonce( wc_clean( wp_unslash( $_POST['_wcsnonce'] ) ), 'wcs_subscription_settings' ) ) {
|
|
return;
|
|
}
|
|
|
|
// Make sure automatic payments are on when manual renewals are switched off
|
|
if ( ! isset( $_POST[ self::$option_prefix . '_accept_manual_renewals' ] ) && isset( $_POST[ self::$option_prefix . '_turn_off_automatic_payments' ] ) ) {
|
|
unset( $_POST[ self::$option_prefix . '_turn_off_automatic_payments' ] );
|
|
}
|
|
|
|
$settings = self::get_settings();
|
|
$defaults_to_find = array(
|
|
self::$option_prefix . '_add_to_cart_button_text' => '',
|
|
self::$option_prefix . '_order_button_text' => '', // phpcs:ignore WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned
|
|
);
|
|
|
|
// Add the $_POST[ 'woocommerce_subscriptions_allow_switching' ] value
|
|
if ( isset( $_POST[ self::$option_prefix . '_allow_switching_variable' ] ) || isset( $_POST[ self::$option_prefix . '_allow_switching_grouped' ] ) ) {
|
|
|
|
$value = array();
|
|
|
|
if ( ! empty( $_POST[ self::$option_prefix . '_allow_switching_variable' ] ) ) {
|
|
$value[] = 'variable';
|
|
unset( $_POST[ self::$option_prefix . '_allow_switching_variable' ] );
|
|
}
|
|
|
|
if ( ! empty( $_POST[ self::$option_prefix . '_allow_switching_grouped' ] ) ) {
|
|
$value[] = 'grouped';
|
|
unset( $_POST[ self::$option_prefix . '_allow_switching_grouped' ] );
|
|
}
|
|
|
|
$_POST[ self::$option_prefix . '_allow_switching' ] = implode( '_', $value );
|
|
|
|
} else {
|
|
$_POST[ self::$option_prefix . '_allow_switching' ] = 'no';
|
|
}
|
|
|
|
foreach ( $settings as $setting ) {
|
|
if ( ! isset( $setting['id'], $setting['default'], $defaults_to_find[ $setting['id'] ], $_POST[ $setting['id'] ] ) ) {
|
|
continue;
|
|
}
|
|
|
|
// Set the setting to its default if no value has been submitted.
|
|
if ( '' === wc_clean( $_POST[ $setting['id'] ] ) ) {
|
|
$_POST[ $setting['id'] ] = $setting['default'];
|
|
}
|
|
|
|
unset( $defaults_to_find[ $setting['id'] ] );
|
|
|
|
// If all defaults have been found, exit.
|
|
if ( ! count( $defaults_to_find ) ) {
|
|
break;
|
|
}
|
|
}
|
|
|
|
// Add extra switching options, if any.
|
|
$extra_switching_options = (array) apply_filters( 'woocommerce_subscriptions_allow_switching_options', array() );
|
|
|
|
foreach ( $extra_switching_options as $option ) {
|
|
|
|
if ( empty( $option['id'] ) || empty( $option['label'] ) ) {
|
|
continue;
|
|
}
|
|
|
|
// Add to $settings to be natively saved.
|
|
$settings[] = array(
|
|
'id' => self::$option_prefix . '_allow_switching_' . $option['id'],
|
|
'type' => 'checkbox', // This will sanitize value to yes/no.
|
|
);
|
|
}
|
|
|
|
woocommerce_update_options( $settings );
|
|
}
|
|
|
|
/**
|
|
* Uses the WooCommerce admin fields API to output settings via the @see woocommerce_admin_fields() function.
|
|
*
|
|
* @uses woocommerce_admin_fields()
|
|
* @uses self::get_settings()
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.0
|
|
*/
|
|
public static function subscription_settings_page() {
|
|
woocommerce_admin_fields( self::get_settings() );
|
|
wp_nonce_field( 'wcs_subscription_settings', '_wcsnonce', false );
|
|
}
|
|
|
|
/**
|
|
* Add the Subscriptions settings tab to the WooCommerce settings tabs array.
|
|
*
|
|
* @param array $settings_tabs Array of WooCommerce setting tabs & their labels, excluding the Subscription tab.
|
|
* @return array $settings_tabs Array of WooCommerce setting tabs & their labels, including the Subscription tab.
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.0
|
|
*/
|
|
public static function add_subscription_settings_tab( $settings_tabs ) {
|
|
|
|
$settings_tabs[ self::$tab_name ] = __( 'Subscriptions', 'woocommerce-subscriptions' );
|
|
|
|
return $settings_tabs;
|
|
}
|
|
|
|
/**
|
|
* Sets default values for all the WooCommerce Subscription options. Called on plugin activation.
|
|
*
|
|
* @see WC_Subscriptions::activate_woocommerce_subscriptions
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.0
|
|
*/
|
|
public static function add_default_settings() {
|
|
foreach ( self::get_settings() as $setting ) {
|
|
if ( isset( $setting['default'] ) ) {
|
|
add_option( $setting['id'], $setting['default'] );
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Deteremines if the subscriptions settings have been setup.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v4.0.0
|
|
* @return bool Whether any subscription settings exist.
|
|
*/
|
|
public static function has_settings() {
|
|
foreach ( self::get_settings() as $setting ) {
|
|
if ( get_option( $setting['id'], false ) !== false ) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Get all the settings for the Subscriptions extension in the format required by the @see woocommerce_admin_fields() function.
|
|
*
|
|
* @return array Array of settings in the format required by the @see woocommerce_admin_fields() function.
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.0
|
|
*/
|
|
public static function get_settings() {
|
|
|
|
/**
|
|
* Filter the settings for the Subscriptions extension.
|
|
*
|
|
* @param array $settings Array of settings in the format required by the woocommerce_admin_fields() function.
|
|
*/
|
|
return apply_filters(
|
|
'woocommerce_subscription_settings',
|
|
array(
|
|
array(
|
|
'name' => _x( 'Miscellaneous', 'options section heading', 'woocommerce-subscriptions' ),
|
|
'type' => 'title',
|
|
'desc' => '',
|
|
'id' => self::$option_prefix . '_miscellaneous',
|
|
),
|
|
|
|
array(
|
|
'name' => __( 'Mixed Checkout', 'woocommerce-subscriptions' ),
|
|
'desc' => __( 'Allow multiple subscriptions and products to be purchased simultaneously.', 'woocommerce-subscriptions' ),
|
|
'id' => self::$option_prefix . '_multiple_purchase',
|
|
'default' => 'no',
|
|
'type' => 'checkbox',
|
|
'desc_tip' => __( 'Allow a subscription product to be purchased with other products and subscriptions in the same transaction.', 'woocommerce-subscriptions' ),
|
|
),
|
|
|
|
array(
|
|
'type' => 'sectionend',
|
|
'id' => self::$option_prefix . '_miscellaneous',
|
|
),
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Displays instructional information for a WooCommerce setting.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.0
|
|
*/
|
|
public static function add_informational_admin_field( $field_details ) {
|
|
|
|
if ( isset( $field_details['name'] ) && $field_details['name'] ) {
|
|
echo '<h3>' . esc_html( $field_details['name'] ) . '</h3>';
|
|
}
|
|
|
|
if ( isset( $field_details['desc'] ) && $field_details['desc'] ) {
|
|
echo wp_kses_post( wpautop( wptexturize( $field_details['desc'] ) ) );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Checks whether a user should be shown pointers or not, based on whether a user has previously dismissed pointers.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.0
|
|
*/
|
|
public static function show_user_pointers() {
|
|
// Get dismissed pointers
|
|
$dismissed = explode( ',', (string) get_user_meta( get_current_user_id(), 'dismissed_wp_pointers', true ) );
|
|
|
|
// Pointer has been dismissed
|
|
if ( in_array( 'wcs_pointer', $dismissed ) ) {
|
|
return false;
|
|
} else {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns a URL for adding/editing a subscription, which special parameters to define whether pointers should be shown.
|
|
*
|
|
* The 'select_subscription' flag is picked up by JavaScript to set the value of the product type to "Subscription".
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.0
|
|
*/
|
|
public static function add_subscription_url( $show_pointers = true ) {
|
|
$add_subscription_url = admin_url( 'post-new.php?post_type=product&select_subscription=true' );
|
|
|
|
if ( true == $show_pointers ) {
|
|
$add_subscription_url = add_query_arg( 'subscription_pointers', 'true', $add_subscription_url );
|
|
}
|
|
|
|
return $add_subscription_url; // nosemgrep: audit.php.wp.security.xss.query-arg -- False positive. The returned URL is escaped where it is used and escaping URLs should be done at the point of output or usage, not on return.
|
|
}
|
|
|
|
/**
|
|
* Searches through the list of active plugins to find WooCommerce. Just in case
|
|
* WooCommerce resides in a folder other than /woocommerce/
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.0
|
|
*/
|
|
public static function get_woocommerce_plugin_dir_file() {
|
|
|
|
$woocommerce_plugin_file = '';
|
|
|
|
foreach ( get_option( 'active_plugins', array() ) as $plugin ) {
|
|
if ( substr( $plugin, strlen( '/woocommerce.php' ) * -1 ) === '/woocommerce.php' ) {
|
|
$woocommerce_plugin_file = $plugin;
|
|
break;
|
|
}
|
|
}
|
|
|
|
return $woocommerce_plugin_file;
|
|
}
|
|
|
|
/**
|
|
* Filter the "Orders" list to show only orders associated with a specific subscription.
|
|
*
|
|
* @param string $where
|
|
* @return string
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
|
|
*/
|
|
public static function filter_orders( $where ) {
|
|
global $typenow, $wpdb;
|
|
|
|
if ( is_admin() && 'shop_order' === $typenow ) {
|
|
|
|
if ( isset( $_GET['_subscription_related_orders'] ) && $_GET['_subscription_related_orders'] > 0 ) {
|
|
|
|
$subscription_id = absint( $_GET['_subscription_related_orders'] );
|
|
|
|
$subscription = wcs_get_subscription( $subscription_id );
|
|
|
|
if ( ! wcs_is_subscription( $subscription ) ) {
|
|
// translators: placeholder is a number
|
|
wcs_add_admin_notice( sprintf( __( 'We can\'t find a subscription with ID #%d. Perhaps it was deleted?', 'woocommerce-subscriptions' ), $subscription_id ), 'error' );
|
|
$where .= " AND {$wpdb->posts}.ID = 0";
|
|
} else {
|
|
self::$found_related_orders = true;
|
|
$where .= sprintf( " AND {$wpdb->posts}.ID IN (%s)", implode( ',', array_map( 'absint', array_unique( $subscription->get_related_orders( 'ids' ) ) ) ) );
|
|
}
|
|
}
|
|
}
|
|
|
|
return $where;
|
|
}
|
|
|
|
/**
|
|
* Filters the Orders Table in HPOS to display_renewal_filter_noticehow only orders associated with a specific subscription.
|
|
*
|
|
* @since 5.2.0
|
|
*
|
|
* @param array $query_vars The query variables.
|
|
*
|
|
* @return array The query variables.
|
|
*/
|
|
public static function filter_orders_table_by_related_orders( $query_vars ) {
|
|
/**
|
|
* Exit early if the request is not to filter the order list table.
|
|
*
|
|
* Note this request isn't nonced as we're only filtering an admin list table and not modifying data.
|
|
*/
|
|
if ( ! ( is_admin() && isset( $_GET['_subscription_related_orders'] ) && $_GET['_subscription_related_orders'] > 0 ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
|
|
return $query_vars;
|
|
}
|
|
|
|
$subscription = wcs_get_subscription( absint( $_GET['_subscription_related_orders'] ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
|
|
|
|
if ( ! wcs_is_subscription( $subscription ) ) {
|
|
$query_vars['post__in'] = [ 0 ];
|
|
} else {
|
|
$query_vars['post__in'] = array_unique( $subscription->get_related_orders( 'ids' ) );
|
|
}
|
|
|
|
return $query_vars;
|
|
}
|
|
|
|
/**
|
|
* Filters the Admin orders and subscriptions table results in HPOS based on a list of IDs returned by a report query.
|
|
*
|
|
* @since 7.1.0
|
|
*
|
|
* @param array $clauses The query clause.
|
|
*
|
|
* @return array $clauses The query clause with additional `where` clause .
|
|
*/
|
|
public static function filter_orders_and_subscriptions_from_order_table( $clauses ) {
|
|
global $wpdb;
|
|
|
|
$query_vars = [
|
|
'page' => '',
|
|
'_report' => '',
|
|
'_orders_list_key' => '',
|
|
'_subscriptions_list_key' => '',
|
|
'_data_key' => '',
|
|
];
|
|
|
|
// phpcs:disable WordPress.Security.NonceVerification.Recommended
|
|
// Map and sanitize $_GET vars to $query_vars.
|
|
foreach ( array_keys( $query_vars ) as $var ) {
|
|
if ( isset( $_GET[ $var ] ) ) {
|
|
$query_vars[ $var ] = sanitize_text_field( wp_unslash( $_GET[ $var ] ) );
|
|
}
|
|
}
|
|
// phpcs:enable WordPress.Security.NonceVerification.Recommended
|
|
|
|
if ( ! ( ! empty( $query_vars['page'] ) && in_array( $query_vars['page'], [ 'wc-orders', 'wc-orders--shop_subscription' ], true ) ) || empty( $query_vars['_report'] ) ) {
|
|
return $clauses;
|
|
}
|
|
|
|
// Map the order or subscription type to their respective keys and type key.
|
|
$object_type = ! empty( $query_vars['_orders_list_key'] ) ? 'order' : ( ! empty( $query_vars['_subscriptions_list_key'] ) ? 'subscription' : '' );
|
|
$cache_report_key = ! empty( $query_vars[ "_{$object_type}s_list_key" ] ) ? $query_vars[ "_{$object_type}s_list_key" ] : '';
|
|
|
|
// If the report key or report arg is empty exit early.
|
|
if ( empty( $cache_report_key ) || empty( $query_vars['_report'] ) ) {
|
|
$clauses['where'] .= " AND {$wpdb->posts}.ID = 0";
|
|
return $clauses;
|
|
}
|
|
|
|
$cache = get_transient( $query_vars['_report'] );
|
|
|
|
// Display an admin notice if we cannot find the report data requested.
|
|
if ( ! isset( $cache[ $cache_report_key ] ) ) {
|
|
$admin_notice = new WCS_Admin_Notice( 'error' );
|
|
$admin_notice->set_simple_content(
|
|
sprintf(
|
|
/* translators: Placeholders are opening and closing link tags. */
|
|
__( 'We weren\'t able to locate the set of report results you requested. Please regenerate the link from the %1$sSubscription Reports screen%2$s.', 'woocommerce-subscriptions' ),
|
|
'<a href="' . esc_url( admin_url( 'admin.php?page=wc-reports&tab=subscriptions&report=subscription_events_by_date' ) ) . '">',
|
|
'</a>'
|
|
)
|
|
);
|
|
$admin_notice->display();
|
|
|
|
$clauses['where'] .= " AND {$wpdb->posts}.ID = 0";
|
|
wc_get_logger()->warning( 'returning 2 $clauses-- ' . wp_json_encode( $clauses ) );
|
|
|
|
return $clauses;
|
|
}
|
|
|
|
$results = $cache[ $cache_report_key ];
|
|
|
|
// The current subscriptions count report will include the specific result (the subscriptions active on the last day) that should be used to generate the subscription list.
|
|
if ( ! empty( $query_vars['_data_key'] ) && isset( $results[ (int) $query_vars['_data_key'] ] ) ) {
|
|
$results = array( $results[ (int) $query_vars['_data_key'] ] );
|
|
}
|
|
|
|
$ids = explode( ',', implode( ',', wp_list_pluck( $results, "{$object_type}_ids", true ) ) );
|
|
$format = implode( ', ', array_fill( 0, count( $ids ), '%d' ) );
|
|
|
|
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared, WordPress.DB.PreparedSQLPlaceholders.UnfinishedPrepare, WordPress.DB.PreparedSQL.InterpolatedNotPrepared
|
|
$clauses['where'] .= $wpdb->prepare( " AND {$wpdb->prefix}wc_orders.ID IN ($format)", $ids );
|
|
|
|
return $clauses;
|
|
}
|
|
|
|
/**
|
|
* Filters the Admin orders and subscriptions table results based on a list of IDs returned by a report query.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.6.2
|
|
*
|
|
* @param string $where The query WHERE clause.
|
|
* @return string $where
|
|
*/
|
|
public static function filter_orders_and_subscriptions_from_list( $where ) {
|
|
global $typenow, $wpdb;
|
|
|
|
if ( ! is_admin() || ! in_array( $typenow, array( 'shop_subscription', 'shop_order' ) ) || ! isset( $_GET['_report'] ) ) {
|
|
return $where;
|
|
}
|
|
|
|
// Map the order or subscription type to their respective keys and type key.
|
|
$object_type = 'shop_order' === $typenow ? 'order' : 'subscription';
|
|
$cache_report_key = isset( $_GET[ "_{$object_type}s_list_key" ] ) ? wc_clean( wp_unslash( $_GET[ "_{$object_type}s_list_key" ] ) ) : '';
|
|
|
|
// If the report key or report arg is empty exit early.
|
|
if ( empty( $cache_report_key ) || empty( $_GET['_report'] ) ) {
|
|
$where .= " AND {$wpdb->posts}.ID = 0";
|
|
return $where;
|
|
}
|
|
|
|
$cache = get_transient( wc_clean( wp_unslash( $_GET['_report'] ) ) );
|
|
|
|
// Display an admin notice if we cannot find the report data requested.
|
|
if ( ! isset( $cache[ $cache_report_key ] ) ) {
|
|
$admin_notice = new WCS_Admin_Notice( 'error' );
|
|
$admin_notice->set_simple_content(
|
|
sprintf(
|
|
/* translators: Placeholders are opening and closing link tags. */
|
|
__( 'We weren\'t able to locate the set of report results you requested. Please regenerate the link from the %1$sSubscription Reports screen%2$s.', 'woocommerce-subscriptions' ),
|
|
'<a href="' . esc_url( admin_url( 'admin.php?page=wc-reports&tab=subscriptions&report=subscription_events_by_date' ) ) . '">',
|
|
'</a>'
|
|
)
|
|
);
|
|
$admin_notice->display();
|
|
|
|
$where .= " AND {$wpdb->posts}.ID = 0";
|
|
return $where;
|
|
}
|
|
|
|
$results = $cache[ $cache_report_key ];
|
|
|
|
// The current subscriptions count report will include the specific result (the subscriptions active on the last day) that should be used to generate the subscription list.
|
|
if ( ! empty( $_GET['_data_key'] ) && isset( $results[ (int) $_GET['_data_key'] ] ) ) {
|
|
$results = array( $results[ (int) $_GET['_data_key'] ] );
|
|
}
|
|
|
|
$ids = explode( ',', implode( ',', wp_list_pluck( $results, "{$object_type}_ids", true ) ) );
|
|
|
|
// $format = '%d, %d, %d, %d, %d, [...]'
|
|
$format = implode( ', ', array_fill( 0, count( $ids ), '%d' ) );
|
|
// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.PreparedSQLPlaceholders.UnfinishedPrepare
|
|
$where .= $wpdb->prepare( " AND {$wpdb->posts}.ID IN ($format)", $ids );
|
|
|
|
return $where;
|
|
}
|
|
|
|
/**
|
|
* Filter the "Orders" list to show only paid subscription orders for a particular user
|
|
*
|
|
* @param string $where
|
|
* @return string
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.5.3
|
|
*/
|
|
public static function filter_paid_subscription_orders_for_user( $where ) {
|
|
global $typenow, $wpdb;
|
|
|
|
if ( ! is_admin() || 'shop_order' !== $typenow || ! isset( $_GET['_paid_subscription_orders_for_customer_user'] ) || 0 == $_GET['_paid_subscription_orders_for_customer_user'] ) {
|
|
return $where;
|
|
}
|
|
|
|
$user_id = wc_clean( wp_unslash( $_GET['_paid_subscription_orders_for_customer_user'] ) );
|
|
|
|
// Unset the GET arg so that it doesn't interfere with the query for user's subscriptions.
|
|
unset( $_GET['_paid_subscription_orders_for_customer_user'] );
|
|
|
|
$users_subscriptions = wcs_get_users_subscriptions( $user_id );
|
|
|
|
$users_subscription_orders = array();
|
|
|
|
foreach ( $users_subscriptions as $subscription ) {
|
|
$users_subscription_orders = array_merge( $users_subscription_orders, $subscription->get_related_orders( 'ids' ) );
|
|
}
|
|
|
|
if ( empty( $users_subscription_orders ) ) {
|
|
wcs_add_admin_notice( sprintf( __( 'We can\'t find a paid subscription order for this user.', 'woocommerce-subscriptions' ) ), 'error' );
|
|
$where .= " AND {$wpdb->posts}.ID = 0";
|
|
} else {
|
|
// Orders with paid status
|
|
$where .= " AND {$wpdb->posts}.post_status IN ( 'wc-processing', 'wc-completed' )";
|
|
$where .= sprintf( " AND {$wpdb->posts}.ID IN (%s)", implode( ',', array_unique( $users_subscription_orders ) ) );
|
|
}
|
|
|
|
return $where;
|
|
}
|
|
|
|
/**
|
|
* Display a notice indicating that the "Orders" list is filtered.
|
|
* @see self::filter_orders()
|
|
*/
|
|
public static function display_renewal_filter_notice() {
|
|
// When HPOS is disabled, use the $found_related_orders static variable to determine if the Orders list is filtered or not.
|
|
if ( ! wcs_is_custom_order_tables_usage_enabled() && ! self::$found_related_orders ) {
|
|
return;
|
|
}
|
|
|
|
/**
|
|
* This request URL isn't nonced because it's only used to display a notice to the user.
|
|
*/
|
|
if ( isset( $_GET['_subscription_related_orders'] ) && $_GET['_subscription_related_orders'] > 0 ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
|
|
$subscription_id = absint( $_GET['_subscription_related_orders'] ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
|
|
$subscription = wcs_get_subscription( $subscription_id );
|
|
|
|
// Display an error notice if we can't find the subscription.
|
|
if ( ! $subscription ) {
|
|
echo '<div id="moderated" class="error"><p>';
|
|
// translators: placeholder is a subscription ID.
|
|
printf( esc_html__( 'We can\'t find a subscription with ID #%d. Perhaps it was deleted?', 'woocommerce-subscriptions' ), esc_html( $subscription_id ) );
|
|
echo '</p></div>';
|
|
return;
|
|
}
|
|
|
|
echo '<div class="updated dismiss-subscriptions-search"><p>';
|
|
// translators: placeholders are opening link tag, ID of sub, and closing link tag
|
|
printf( esc_html__( 'Showing orders for %1$sSubscription %2$s%3$s', 'woocommerce-subscriptions' ), '<a href="' . esc_url( wcs_get_edit_post_link( $subscription ) ) . '">', esc_html( $subscription->get_order_number() ), '</a>' );
|
|
echo '</p>';
|
|
printf(
|
|
'<a href="%1$s" class="notice-dismiss"><span class="screen-reader-text">Dismiss this notice.</span></a>',
|
|
esc_url( remove_query_arg( '_subscription_related_orders' ) )
|
|
);
|
|
|
|
echo '</div>';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns either a string or array of strings describing the allowable trial period range
|
|
* for a subscription.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.0
|
|
*/
|
|
public static function get_trial_period_validation_message( $form = 'combined' ) {
|
|
|
|
$subscription_ranges = wcs_get_subscription_ranges();
|
|
|
|
if ( 'combined' == $form ) {
|
|
// translators: number of 1$: days, 2$: weeks, 3$: months, 4$: years
|
|
$error_message = sprintf( __( 'The trial period can not exceed: %1$s, %2$s, %3$s or %4$s.', 'woocommerce-subscriptions' ), array_pop( $subscription_ranges['day'] ), array_pop( $subscription_ranges['week'] ), array_pop( $subscription_ranges['month'] ), array_pop( $subscription_ranges['year'] ) );
|
|
} else {
|
|
$error_message = array();
|
|
foreach ( wcs_get_available_time_periods() as $period => $string ) {
|
|
// translators: placeholder is a time period (e.g. "4 weeks")
|
|
$error_message[ $period ] = sprintf( __( 'The trial period can not exceed %s.', 'woocommerce-subscriptions' ), array_pop( $subscription_ranges[ $period ] ) );
|
|
}
|
|
}
|
|
|
|
return apply_filters( 'woocommerce_subscriptions_trial_period_validation_message', $error_message );
|
|
}
|
|
|
|
/**
|
|
* Displays the content for the [subscriptions] shortcode.
|
|
*
|
|
* The subscriptions shortcode can be used to display customer subscriptions similar to the my account list page.
|
|
* Shortcode args enable filtering by status and user ID.
|
|
*
|
|
* @param array $attributes shortcode attributes.
|
|
* @return string The shortcode content.
|
|
*/
|
|
public static function do_subscriptions_shortcode( $attributes ) {
|
|
|
|
// Display a notice if the user isn't logged in.
|
|
if ( ! is_user_logged_in() ) {
|
|
// We cannot show notices on admin requests - eg page previews.
|
|
if ( is_admin() ) {
|
|
return;
|
|
}
|
|
|
|
return wc_print_notice( esc_html__( 'Please log in to your account to view your subscriptions.', 'woocommerce-subscriptions' ), 'error', [], true );
|
|
}
|
|
|
|
$attributes = shortcode_atts(
|
|
array(
|
|
'user_id' => 0,
|
|
'status' => 'active',
|
|
),
|
|
$attributes,
|
|
'subscriptions'
|
|
);
|
|
|
|
$subscriptions = wcs_get_users_subscriptions( $attributes['user_id'] );
|
|
$apply_status_filter = 'all' !== $attributes['status'] && 'any' !== $attributes['status'];
|
|
|
|
// Determine if the current user has permission to view the subscriptions.
|
|
// By default, only the user themselves can view their subscriptions.
|
|
$display_permissions_notice = ! empty( $attributes['user_id'] ) && get_current_user_id() !== absint( $attributes['user_id'] );
|
|
|
|
foreach ( $subscriptions as $index => $subscription ) {
|
|
if ( $apply_status_filter && ! $subscription->has_status( $attributes['status'] ) ) {
|
|
unset( $subscriptions[ $index ] );
|
|
}
|
|
|
|
// Remove any subscriptions the current user cannot view. WooCommerce admins can view all subscriptions.
|
|
if ( ! current_user_can( 'manage_woocommerce' ) && ! current_user_can( 'view_order', $subscription->get_id() ) ) {
|
|
unset( $subscriptions[ $index ] );
|
|
$display_permissions_notice = true;
|
|
}
|
|
}
|
|
|
|
// If all the subscriptions were removed and the current user doesn't have permissions, display a notice. Note: We cannot show notices on admin requests - eg page previews.
|
|
if ( empty( $subscriptions ) && $display_permissions_notice ) {
|
|
// We cannot show notices on admin requests - eg page previews.
|
|
if ( is_admin() ) {
|
|
return;
|
|
} elseif ( current_user_can( 'manage_woocommerce' ) ) {
|
|
return wc_print_notice( esc_html__( 'No subscriptions found for that customer.', 'woocommerce-subscriptions' ), 'notice', [], true );
|
|
} else {
|
|
return wc_print_notice( esc_html__( 'You do not have permission to view those subscriptions.', 'woocommerce-subscriptions' ), 'error', [], true );
|
|
}
|
|
}
|
|
|
|
// Load the subscription template, and return its content using Output Buffering.
|
|
ob_start();
|
|
wc_get_template(
|
|
'myaccount/my-subscriptions.php',
|
|
array(
|
|
'subscriptions' => $subscriptions,
|
|
'user_id' => $attributes['user_id'],
|
|
'current_page' => 1,
|
|
'max_num_pages' => 1,
|
|
'paginate' => false,
|
|
),
|
|
'',
|
|
WC_Subscriptions_Plugin::instance()->get_plugin_directory( 'templates/' )
|
|
);
|
|
|
|
return ob_get_clean();
|
|
}
|
|
|
|
/**
|
|
* Adds Subscriptions specific details to the WooCommerce System Status report.
|
|
*
|
|
* @param array $debug_data
|
|
* @return array
|
|
*/
|
|
public static function add_system_status_items( $debug_data ) {
|
|
_deprecated_function( __METHOD__, '2.2.2', __CLASS__ . '::render_system_status_items()' );
|
|
|
|
$is_wcs_debug = defined( 'WCS_DEBUG' ) ? WCS_DEBUG : false;
|
|
|
|
$debug_data['wcs_debug'] = array(
|
|
'name' => _x( 'WCS_DEBUG', 'label that indicates whether debugging is turned on for the plugin', 'woocommerce-subscriptions' ),
|
|
'note' => ( $is_wcs_debug ) ? __( 'Yes', 'woocommerce-subscriptions' ) : __( 'No', 'woocommerce-subscriptions' ),
|
|
'success' => $is_wcs_debug ? 0 : 1,
|
|
);
|
|
|
|
$debug_data['wcs_staging'] = array(
|
|
'name' => _x( 'Subscriptions Mode', 'Live or Staging, Label on WooCommerce -> System Status page', 'woocommerce-subscriptions' ),
|
|
'note' => '<strong>' . ( ( WCS_Staging::is_duplicate_site() ) ? _x( 'Staging', 'refers to staging site', 'woocommerce-subscriptions' ) : _x( 'Live', 'refers to live site', 'woocommerce-subscriptions' ) ) . '</strong>',
|
|
'success' => ( WCS_Staging::is_duplicate_site() ) ? 0 : 1,
|
|
);
|
|
|
|
return $debug_data;
|
|
}
|
|
|
|
/**
|
|
* A WooCommerce version aware function for getting the Subscriptions admin settings
|
|
* tab URL.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.4.5
|
|
* @return string
|
|
*/
|
|
public static function settings_tab_url() {
|
|
|
|
$settings_tab_url = admin_url( 'admin.php?page=wc-settings&tab=subscriptions' );
|
|
|
|
return apply_filters( 'woocommerce_subscriptions_settings_tab_url', $settings_tab_url );
|
|
}
|
|
|
|
/**
|
|
* Add a column to the Payment Gateway table to show whether the gateway supports automated renewals.
|
|
*
|
|
* @param array $header
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.5.3
|
|
* @return array
|
|
*/
|
|
public static function payment_gateways_renewal_column( $header ) {
|
|
$header_new = array_slice( $header, 0, count( $header ) - 1, true ) + array( 'renewals' => __( 'Automatic Recurring Payments', 'woocommerce-subscriptions' ) ) // Ideally, we could add a link to the docs here, but the title is passed through esc_html()
|
|
+ array_slice( $header, count( $header ) - 1, count( $header ) - ( count( $header ) - 1 ), true );
|
|
|
|
return $header_new;
|
|
}
|
|
|
|
/**
|
|
* Add a column to the Payment Gateway table to show whether the gateway supports automated renewals.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5
|
|
* @deprecated 1.0.0 - Migrated from WooCommerce Subscriptions v2.5.3
|
|
* @return string
|
|
*/
|
|
public static function payment_gateways_rewewal_column( $header ) {
|
|
wcs_deprecated_function( __METHOD__, '2.5.3', 'WC_Subscriptions_Admin::payment_gateways_renewal_column( $header )' );
|
|
|
|
return self::payment_gateways_renewal_column( $header );
|
|
}
|
|
|
|
/**
|
|
* Check whether the payment gateway passed in supports automated renewals or not.
|
|
* Automatically flag support for Paypal since it is included with subscriptions.
|
|
* Display in the Payment Gateway column.
|
|
*
|
|
* @param WC_Payment_Gateway $gateway
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.5.3
|
|
*/
|
|
public static function payment_gateways_renewal_support( $gateway ) {
|
|
$payment_gateways_handler = WC_Subscriptions_Core_Plugin::instance()->get_gateways_handler_class();
|
|
|
|
echo '<td class="renewals">';
|
|
if ( $payment_gateways_handler::gateway_supports_subscriptions( $gateway ) ) {
|
|
$status_html = '<span class="status-enabled tips" data-tip="' . esc_attr__( 'Supports automatic renewal payments.', 'woocommerce-subscriptions' ) . '">' . esc_html__( 'Yes', 'woocommerce-subscriptions' ) . '</span>';
|
|
} else {
|
|
$status_html = '-';
|
|
}
|
|
|
|
$allowed_html = wp_kses_allowed_html( 'post' );
|
|
$allowed_html['span']['data-tip'] = true;
|
|
|
|
/**
|
|
* Automatic Renewal Payments Support Status HTML Filter.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
|
|
*
|
|
* @param string $status_html
|
|
* @param \WC_Payment_Gateway $gateway
|
|
*/
|
|
echo wp_kses( apply_filters( 'woocommerce_payment_gateways_renewal_support_status_html', $status_html, $gateway ), $allowed_html );
|
|
|
|
echo '</td>';
|
|
}
|
|
|
|
/**
|
|
* Check whether the payment gateway passed in supports automated renewals or not.
|
|
* Automatically flag support for Paypal since it is included with subscriptions.
|
|
* Display in the Payment Gateway column.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5
|
|
* @deprecated 1.0.0 - Migrated from WooCommerce Subscriptions v2.5.3
|
|
*/
|
|
public static function payment_gateways_rewewal_support( $gateway ) {
|
|
wcs_deprecated_function( __METHOD__, '2.5.3', 'WC_Subscriptions_Admin::payment_gateways_renewal_support( $gateway )' );
|
|
|
|
return self::payment_gateways_renewal_support( $gateway );
|
|
}
|
|
|
|
/**
|
|
* Do not display formatted order total on the Edit Order administration screen
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5.17
|
|
* @deprecated 7.5.0
|
|
*/
|
|
public static function maybe_remove_formatted_order_total_filter( $formatted_total, $order ) {
|
|
wcs_deprecated_function( __METHOD__, '7.5.0' );
|
|
|
|
return $formatted_total;
|
|
}
|
|
|
|
/**
|
|
* Only attach the gettext callback when on admin shop subscription screen
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.2.7
|
|
*/
|
|
public static function maybe_attach_gettext_callback() {
|
|
|
|
if ( self::is_edit_subscription_page() ) {
|
|
add_filter( 'gettext', array( __CLASS__, 'change_order_item_editable_text' ), 10, 3 );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Only unattach the gettext callback when it was attached
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.2.7
|
|
*/
|
|
public static function maybe_unattach_gettext_callback() {
|
|
|
|
if ( self::is_edit_subscription_page() ) {
|
|
remove_filter( 'gettext', array( __CLASS__, 'change_order_item_editable_text' ), 10 );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* When subscription items not editable (such as due to the payment gateway not supporting modifications),
|
|
* change the text to explain why
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.2.7
|
|
*/
|
|
public static function change_order_item_editable_text( $translated_text, $text, $domain ) {
|
|
|
|
switch ( $text ) {
|
|
case 'This order is no longer editable.':
|
|
$translated_text = __( 'Subscription items can no longer be edited.', 'woocommerce-subscriptions' );
|
|
break;
|
|
|
|
case 'To edit this order change the status back to "Pending"':
|
|
case 'To edit this order change the status back to "Pending payment"':
|
|
$translated_text = __( 'This subscription is no longer editable because the payment gateway does not allow modification of recurring amounts.', 'woocommerce-subscriptions' );
|
|
break;
|
|
}
|
|
|
|
return $translated_text;
|
|
}
|
|
|
|
/**
|
|
* Add recurring payment gateway information after the Settings->Payments->Payment Methods table.
|
|
* This includes information about manual renewals and a warning if no payment gateway which supports automatic recurring payments is enabled/setup correctly.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.1
|
|
*/
|
|
public static function add_recurring_payment_gateway_information( $settings ) {
|
|
$available_gateways_description = '';
|
|
$payment_gateways_handler = WC_Subscriptions_Core_Plugin::instance()->get_gateways_handler_class();
|
|
|
|
if ( ! $payment_gateways_handler::one_gateway_supports( 'subscriptions' ) ) {
|
|
// translators: $1-2: opening and closing tags of a link that takes to Woo marketplace / Stripe product page
|
|
$available_gateways_description = sprintf( __( 'No payment gateways capable of processing automatic subscription payments are enabled. If you would like to process automatic payments, we recommend %1$sWooPayments%2$s.', 'woocommerce-subscriptions' ), '<strong><a href="https://woocommerce.com/payments/">', '</a></strong>' );
|
|
}
|
|
|
|
$recurring_payment_settings = apply_filters(
|
|
'woocommerce_subscriptions_admin_recurring_payment_information',
|
|
array(
|
|
array(
|
|
'name' => __( 'Recurring Payments', 'woocommerce-subscriptions' ),
|
|
'desc' => $available_gateways_description,
|
|
'id' => self::$option_prefix . '_payment_gateways_available',
|
|
'type' => 'informational',
|
|
),
|
|
|
|
array(
|
|
// translators: placeholders are opening and closing link tags
|
|
'desc' => sprintf( __( 'Payment gateways which don\'t support automatic recurring payments can be used to process %1$smanual subscription renewal payments%2$s.', 'woocommerce-subscriptions' ), '<a href="https://woocommerce.com/document/subscriptions/renewal-process/">', '</a>' ),
|
|
'id' => self::$option_prefix . '_payment_gateways_additional',
|
|
'type' => 'informational',
|
|
),
|
|
),
|
|
self::$option_prefix
|
|
);
|
|
|
|
$insert_index = array_search(
|
|
array(
|
|
'type' => 'sectionend',
|
|
'id' => 'payment_gateways_options',
|
|
),
|
|
$settings
|
|
);
|
|
|
|
// reconstruct the settings array, inserting the new settings after the payment gatways table
|
|
$checkout_settings = array();
|
|
|
|
foreach ( $settings as $key => $value ) {
|
|
|
|
$checkout_settings[ $key ] = $value;
|
|
unset( $settings[ $key ] );
|
|
|
|
if ( $key == $insert_index ) {
|
|
$checkout_settings = array_merge( $checkout_settings, $recurring_payment_settings, $settings );
|
|
break;
|
|
}
|
|
}
|
|
|
|
return $checkout_settings;
|
|
}
|
|
|
|
/**
|
|
* Check if subscription product meta data should be saved for the current request.
|
|
*
|
|
* @param int $post_id The ID of the post being saved.
|
|
* @param array $product_types Array of product types.
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.2.9
|
|
*/
|
|
private static function is_subscription_product_save_request( $post_id, $product_types ) {
|
|
|
|
if ( self::$saved_product_meta ) {
|
|
$is_subscription_product_save_request = false;
|
|
} elseif ( empty( $_POST['_wcsnonce'] ) || ! wp_verify_nonce( wc_clean( wp_unslash( $_POST['_wcsnonce'] ) ), 'wcs_subscription_meta' ) ) {
|
|
$is_subscription_product_save_request = false;
|
|
} elseif ( ! isset( $_POST['product-type'] ) || ! in_array( $_POST['product-type'], $product_types ) ) {
|
|
$is_subscription_product_save_request = false;
|
|
} elseif ( empty( $_POST['post_ID'] ) || $_POST['post_ID'] != $post_id ) {
|
|
$is_subscription_product_save_request = false;
|
|
} else {
|
|
$is_subscription_product_save_request = true;
|
|
}
|
|
|
|
return apply_filters( 'wcs_admin_is_subscription_product_save_request', $is_subscription_product_save_request, $post_id, $product_types );
|
|
}
|
|
|
|
/**
|
|
* Insert a setting or an array of settings after another specific setting by its ID.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.2.20
|
|
* @param array $settings The original list of settings. Passed by reference.
|
|
* @param string $insert_after_setting_id The setting id to insert the new setting after.
|
|
* @param array $new_setting The new setting to insert. Can be a single setting or an array of settings.
|
|
* @param string $insert_type The type of insert to perform. Can be 'single_setting' or 'multiple_settings'. Optional. Defaults to a single setting insert.
|
|
* @param string $insert_after The setting type to insert the new settings after. Optional. Default is 'first' - the setting will be inserted after the first occurring setting with the matching ID (no specific type). Pass a setting type (like 'sectionend') to insert after a setting type.
|
|
*/
|
|
public static function insert_setting_after( &$settings, $insert_after_setting_id, $new_setting, $insert_type = 'single_setting', $insert_after = 'first' ) {
|
|
if ( ! is_array( $settings ) ) {
|
|
return;
|
|
}
|
|
|
|
$original_settings = $settings;
|
|
$settings = array();
|
|
$inserted = false;
|
|
|
|
foreach ( $original_settings as $setting ) {
|
|
$settings[] = $setting;
|
|
|
|
if ( $inserted ) {
|
|
continue;
|
|
}
|
|
|
|
if ( 'first' !== $insert_after && isset( $setting['type'] ) && $setting['type'] !== $insert_after ) {
|
|
continue;
|
|
}
|
|
|
|
if ( isset( $setting['id'] ) && $insert_after_setting_id === $setting['id'] ) {
|
|
if ( 'single_setting' === $insert_type ) {
|
|
$settings[] = $new_setting;
|
|
} else {
|
|
$settings = array_merge( $settings, $new_setting );
|
|
}
|
|
|
|
$inserted = true;
|
|
}
|
|
}
|
|
|
|
return $inserted;
|
|
}
|
|
|
|
/**
|
|
* Add a reminder on the enable guest checkout setting that subscriptions still require an account
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.3.0
|
|
* @param array $settings The list of settings
|
|
*/
|
|
public static function add_guest_checkout_setting_note( $settings ) {
|
|
$is_wc_pre_3_4_0 = wcs_is_woocommerce_pre( '3.4.0' );
|
|
$current_filter = current_filter();
|
|
|
|
if ( ( $is_wc_pre_3_4_0 && 'woocommerce_payment_gateways_settings' !== $current_filter ) || ( ! $is_wc_pre_3_4_0 && 'woocommerce_account_settings' !== $current_filter ) ) {
|
|
return $settings;
|
|
}
|
|
|
|
if ( ! is_array( $settings ) ) {
|
|
return $settings;
|
|
}
|
|
|
|
foreach ( $settings as &$value ) {
|
|
if ( isset( $value['id'] ) && 'woocommerce_enable_guest_checkout' === $value['id'] ) {
|
|
$value['desc_tip'] = ! empty( $value['desc_tip'] ) ? $value['desc_tip'] . ' ' : '';
|
|
$value['desc_tip'] .= __( 'Note that purchasing a subscription still requires an account.', 'woocommerce-subscriptions' );
|
|
break;
|
|
}
|
|
}
|
|
return $settings;
|
|
}
|
|
|
|
/**
|
|
* Gets the product type warning message displayed for products associated with subscriptions
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v3.0.7
|
|
* @return string The change product type warning message.
|
|
*/
|
|
private static function get_change_product_type_warning() {
|
|
return __( 'The product type can not be changed because this product is associated with subscriptions.', 'woocommerce-subscriptions' );
|
|
}
|
|
|
|
/**
|
|
* Validates the product type change before other product data is saved.
|
|
*
|
|
* Subscription products associated with subscriptions cannot be changed. Doing so
|
|
* can cause issues. For example when customers who try to manually renew where the subscription
|
|
* products are placed in the cart.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v3.0.7
|
|
* @param int $product_id The product ID being saved.
|
|
*/
|
|
public static function validate_product_type_change( $product_id ) {
|
|
|
|
if ( empty( $_POST['woocommerce_meta_nonce'] ) || ! wp_verify_nonce( wc_clean( wp_unslash( $_POST['woocommerce_meta_nonce'] ) ), 'woocommerce_save_data' ) || empty( $_POST['product-type'] ) ) {
|
|
return;
|
|
}
|
|
|
|
$current_product_type = WC_Product_Factory::get_product_type( $product_id );
|
|
|
|
// Only validate subscription product type changes.
|
|
if ( 'subscription' !== $current_product_type && 'variable-subscription' !== $current_product_type ) {
|
|
return;
|
|
}
|
|
|
|
$new_product_type = sanitize_title( wp_unslash( $_POST['product-type'] ) );
|
|
|
|
// Display an error and don't save the product if the type is changing and it's linked to subscriptions.
|
|
if ( $new_product_type !== $current_product_type && (bool) wcs_get_subscriptions_for_product( $product_id, 'ids', array( 'limit' => 1 ) ) ) {
|
|
wcs_add_admin_notice( self::get_change_product_type_warning(), 'error' );
|
|
wp_safe_redirect( get_admin_url( null, "post.php?post={$product_id}&action=edit" ) );
|
|
exit;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Adds a setting to allow customer registration on checkout specifically for subscription purchases.
|
|
*
|
|
* If the store allows registration on the checkout, this setting is hidden because that higher level
|
|
* setting overrides any need for a specific subscription setting.
|
|
*
|
|
* This setting allows stores to enable users to create an account when purchasing a subscription, but
|
|
* not allow an account to be created when they are making one off/standard purchases.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v3.1.0
|
|
*
|
|
* @param array $settings The Accounts & Privacy settings.
|
|
* @return array $settings.
|
|
*/
|
|
public static function add_registration_for_subscription_purchases_setting( $settings ) {
|
|
|
|
self::insert_setting_after(
|
|
$settings,
|
|
'woocommerce_enable_signup_and_login_from_checkout',
|
|
array(
|
|
'id' => 'woocommerce_enable_signup_from_checkout_for_subscriptions',
|
|
'name' => __( 'Allow subscription customers to create an account during checkout', 'woocommerce-subscriptions' ),
|
|
'desc' => __( 'Allow subscription customers to create an account during checkout', 'woocommerce-subscriptions' ),
|
|
'default' => 'yes',
|
|
'type' => 'checkbox',
|
|
'checkboxgroup' => '',
|
|
'autoload' => false,
|
|
)
|
|
);
|
|
|
|
return $settings;
|
|
}
|
|
|
|
/**
|
|
* Renders the Subscription information in the WC status page
|
|
*/
|
|
public static function render_system_status_items() {
|
|
_deprecated_function( __METHOD__, '2.3', 'WCS_Admin_System_Status::render_system_status_items()' );
|
|
WCS_Admin_System_Status::render_system_status_items();
|
|
}
|
|
|
|
/**
|
|
* Outputs the contents of the "Renewal Orders" meta box.
|
|
*
|
|
* @param object $post Current post data.
|
|
*/
|
|
public static function related_orders_meta_box( $post ) {
|
|
_deprecated_function( __METHOD__, '2.0', 'WCS_Meta_Box_Related_Orders::output()' );
|
|
WCS_Meta_Box_Related_Orders::output( $post );
|
|
}
|
|
|
|
/**
|
|
* Add users with subscriptions to the "Customers" report in WooCommerce -> Reports.
|
|
*
|
|
* @param WP_User_Query $user_query
|
|
*/
|
|
public static function add_subscribers_to_customers( $user_query ) {
|
|
_deprecated_function( __METHOD__, '2.0' );
|
|
}
|
|
|
|
/**
|
|
* Set a translation safe screen ID for Subscriptions
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.3.3
|
|
*/
|
|
public static function set_admin_screen_id() {
|
|
_deprecated_function( __METHOD__, '2.0' );
|
|
}
|
|
|
|
/**
|
|
* Once we have set a correct admin page screen ID, we can use it for adding the Manage Subscriptions table's columns.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.3.3
|
|
*/
|
|
public static function add_subscriptions_table_column_filter() {
|
|
_deprecated_function( __METHOD__, '2.0' );
|
|
}
|
|
|
|
/**
|
|
* Filter the "Orders" list to show only renewal orders associated with a specific parent order.
|
|
*
|
|
* @param array $request
|
|
* @return array
|
|
*/
|
|
public static function filter_orders_by_renewal_parent( $request ) {
|
|
_deprecated_function( __METHOD__, '2.0' );
|
|
return $request;
|
|
}
|
|
|
|
/**
|
|
* Registers the "Renewal Orders" meta box for the "Edit Order" page.
|
|
* @deprecated 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
|
|
*/
|
|
public static function add_meta_boxes() {
|
|
_deprecated_function( __METHOD__, '2.0', 'WCS_Admin_Meta_Boxes::add_meta_boxes()' );
|
|
}
|
|
|
|
/**
|
|
* Output the metabox
|
|
*/
|
|
public static function recurring_totals_meta_box( $post ) {
|
|
_deprecated_function( __METHOD__, '2.0' );
|
|
}
|
|
|
|
/**
|
|
* Filters the Admin orders table results based on a list of IDs returned by a report query.
|
|
*
|
|
* @deprecated 1.0.0 - Migrated from WooCommerce Subscriptions v2.6.2
|
|
*
|
|
* @param string $where The query WHERE clause.
|
|
* @return string $where
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.6.0
|
|
*/
|
|
public static function filter_orders_from_list( $where ) {
|
|
wcs_deprecated_function( __METHOD__, '2.6.2', 'WC_Subscriptions_Admin::filter_orders_and_subscriptions_from_list( $where )' );
|
|
|
|
return self::filter_orders_and_subscriptions_from_list( $where );
|
|
}
|
|
|
|
/**
|
|
* Filters the Admin subscriptions table results based on a list of IDs returned by a report query.
|
|
*
|
|
* @deprecated 1.0.0 - Migrated from WooCommerce Subscriptions v2.6.2
|
|
*
|
|
* @param string $where The query WHERE clause.
|
|
* @return string
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.6.0
|
|
*/
|
|
public static function filter_subscriptions_from_list( $where ) {
|
|
wcs_deprecated_function( __METHOD__, '2.6.2', 'WC_Subscriptions_Admin::filter_orders_and_subscriptions_from_list( $where )' );
|
|
|
|
return self::filter_orders_and_subscriptions_from_list( $where );
|
|
}
|
|
|
|
/**
|
|
* Prevents variations from being deleted if switching from a variable product type to a subscription variable product type (and vice versa).
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v3.0.14
|
|
*
|
|
* @param bool $delete_variations A boolean value of true will delete the variations.
|
|
* @param WC_Product $product Product data.
|
|
* @return string $from Origin type.
|
|
* @param string $to New type.
|
|
*
|
|
* @return bool Whether the variations should be deleted.
|
|
*/
|
|
public static function maybe_keep_variations( $delete_variations, $product, $from, $to ) {
|
|
|
|
if ( ( 'variable' === $from && 'variable-subscription' === $to ) || ( 'variable-subscription' === $from && 'variable' === $to ) ) {
|
|
$delete_variations = false;
|
|
}
|
|
|
|
return $delete_variations;
|
|
}
|
|
|
|
/**
|
|
* Check if the current page is the Edit Subscription page
|
|
*
|
|
* @return bool True if the current page is the Edit Subscription page
|
|
*
|
|
* @since 7.5.0
|
|
*/
|
|
private static function is_edit_subscription_page() {
|
|
if ( ! is_admin() || ! function_exists( 'get_current_screen' ) ) {
|
|
return false;
|
|
}
|
|
|
|
$screen = get_current_screen();
|
|
if ( ! is_object( $screen ) ) {
|
|
return false;
|
|
}
|
|
|
|
return wcs_get_page_screen_id( 'shop_subscription' ) === $screen->id;
|
|
}
|
|
}
|