mirror of
https://github.com/pronamic/woocommerce-subscriptions.git
synced 2025-10-10 19:32:57 +00:00
1699 lines
70 KiB
PHP
1699 lines
70 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
|
|
* @author Brent Shepherd
|
|
* @since 1.0
|
|
*/
|
|
class WC_Subscriptions_Admin {
|
|
|
|
/**
|
|
* The WooCommerce settings tab name
|
|
*
|
|
* @since 1.0
|
|
*/
|
|
public static $tab_name = 'subscriptions';
|
|
|
|
/**
|
|
* The prefix for subscription settings
|
|
*
|
|
* @since 1.0
|
|
*/
|
|
public static $option_prefix = 'woocommerce_subscriptions';
|
|
|
|
/**
|
|
* Store an instance of the list table
|
|
*
|
|
* @since 1.4.6
|
|
*/
|
|
private static $subscriptions_list_table;
|
|
|
|
/**
|
|
* Store an instance of the list table
|
|
*
|
|
* @since 2.0
|
|
*/
|
|
private static $found_related_orders = false;
|
|
|
|
/**
|
|
* Is meta boxes saved once?
|
|
*
|
|
* @var boolean
|
|
* @since 2.2.0
|
|
*/
|
|
private static $saved_product_meta = false;
|
|
|
|
/**
|
|
* Bootstraps the class and hooks required actions & filters.
|
|
*
|
|
* @since 1.0
|
|
*/
|
|
public static function init() {
|
|
|
|
// Add subscriptions to the product select box
|
|
add_filter( 'product_type_selector', __CLASS__ . '::add_subscription_products_to_select' );
|
|
|
|
// 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
|
|
add_action( 'woocommerce_product_options_shipping', __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_tabs_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' );
|
|
|
|
add_filter( 'posts_where', __CLASS__ . '::filter_orders' );
|
|
|
|
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_system_status_report', __CLASS__ . '::render_system_status_items' );
|
|
|
|
add_filter( 'woocommerce_payment_gateways_setting_columns', __CLASS__ . '::payment_gateways_rewewal_column' );
|
|
|
|
add_action( 'woocommerce_payment_gateways_setting_column_renewals', __CLASS__ . '::payment_gateways_rewewal_support' );
|
|
|
|
// Do not display formatted order total on the Edit Order administration screen
|
|
add_filter( 'woocommerce_get_formatted_order_total', __CLASS__ . '::maybe_remove_formatted_order_total_filter', 0, 2 );
|
|
|
|
add_action( 'woocommerce_payment_gateways_settings', __CLASS__ . '::add_recurring_payment_gateway_information', 10 , 1 );
|
|
|
|
// Change text for when order items cannot be edited
|
|
add_action( 'woocommerce_admin_order_totals_after_refunded', __CLASS__ . '::maybe_attach_gettext_callback', 10, 1 );
|
|
// Unhook gettext callback to prevent extra call impact
|
|
add_action( 'woocommerce_order_item_add_action_buttons', __CLASS__ . '::maybe_unattach_gettext_callback', 10, 1 );
|
|
}
|
|
|
|
/**
|
|
* Clear all transients data we have when the WooCommerce::Tools::Clear Transients action is
|
|
* triggered.
|
|
*
|
|
* @since 2.1.1
|
|
*
|
|
* @return null
|
|
*/
|
|
public static function clear_subscriptions_transients() {
|
|
global $wpdb;
|
|
if ( empty( $_GET['action'] ) || empty( $_REQUEST['_wpnonce'] ) || ! wp_verify_nonce( $_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',
|
|
);
|
|
|
|
// 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 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
|
|
*/
|
|
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;
|
|
}
|
|
|
|
/**
|
|
* Output the subscription specific pricing fields on the "Edit Product" admin page.
|
|
*
|
|
* @since 1.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
|
|
if ( ! $chosen_period = get_post_meta( $post->ID, '_subscription_period', true ) ) {
|
|
$chosen_period = 'month';
|
|
}
|
|
|
|
echo '<div class="options_group subscription_pricing show_if_subscription">';
|
|
|
|
// Subscription Price, Interval and Period
|
|
?><p class="form-field _subscription_price_fields _subscription_price_field">
|
|
<label for="_subscription_price"><?php printf( esc_html__( 'Subscription price (%s)', 'woocommerce-subscriptions' ), esc_html( get_woocommerce_currency_symbol() ) ); ?></label>
|
|
<span class="wrap">
|
|
<input type="text" id="_subscription_price" name="_subscription_price" class="wc_input_price wc_input_subscription_price" placeholder="<?php echo esc_attr_x( 'e.g. 5.90', 'example price', 'woocommerce-subscriptions' ); ?>" step="any" min="0" value="<?php echo esc_attr( $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">
|
|
<?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" >
|
|
<?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 echo wcs_help_tip( $price_tooltip ); ?>
|
|
</p><?php
|
|
|
|
// Subscription Length
|
|
woocommerce_wp_select( array(
|
|
'id' => '_subscription_length',
|
|
'class' => 'wc_input_subscription_length select short',
|
|
'label' => __( 'Subscription length', 'woocommerce-subscriptions' ),
|
|
'options' => wcs_get_subscription_ranges( $chosen_period ),
|
|
'desc_tip' => true,
|
|
'description' => __( 'Automatically expire 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',
|
|
'class' => 'wc_input_subscription_intial_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' => _x( 'e.g. 9.90', 'example price', 'woocommerce-subscriptions' ),
|
|
'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',
|
|
'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" >
|
|
<?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 echo wcs_help_tip( $trial_tooltip ); ?>
|
|
</p><?php
|
|
|
|
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 2.0
|
|
*/
|
|
public static function subscription_shipping_fields() {
|
|
global $post;
|
|
|
|
echo '</div>';
|
|
echo '<div class="options_group subscription_one_time_shipping show_if_subscription show_if_variable-subscription">';
|
|
|
|
// 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' );
|
|
|
|
}
|
|
|
|
/**
|
|
* Output advanced subscription options on the "Edit Product" admin screen
|
|
* @deprecated 2.1
|
|
* @since 1.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.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( plugin_dir_path( WC_Subscriptions::$plugin_file ) . '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.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( 'Subscription length', '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 array 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
|
|
*/
|
|
public static function save_subscription_meta( $post_id ) {
|
|
|
|
if ( self::$saved_product_meta || ( empty( $_POST['_wcsnonce'] ) || ! wp_verify_nonce( $_POST['_wcsnonce'], 'wcs_subscription_meta' ) || ! isset( $_POST['product-type'] ) || ! in_array( $_POST['product-type'], apply_filters( 'woocommerce_subscription_product_types', array( WC_Subscriptions::$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 );
|
|
|
|
$date_from = ( isset( $_POST['_sale_price_dates_from'] ) ) ? wcs_date_to_time( $_POST['_sale_price_dates_from'] ) : '';
|
|
$date_to = ( isset( $_POST['_sale_price_dates_to'] ) ) ? wcs_date_to_time( $_POST['_sale_price_dates_to'] ) : '';
|
|
|
|
$now = gmdate( 'U' );
|
|
|
|
if ( ! empty( $date_to ) && empty( $date_from ) ) {
|
|
$date_from = $now;
|
|
}
|
|
|
|
update_post_meta( $post_id, '_sale_price_dates_from', $date_from );
|
|
update_post_meta( $post_id, '_sale_price_dates_to', $date_to );
|
|
|
|
// Update price if on sale
|
|
if ( ! empty( $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 = count( $subscription_ranges[ $_POST['_subscription_trial_period'] ] ) - 1;
|
|
|
|
$_POST['_subscription_trial_length'] = absint( $_POST['_subscription_trial_length'] );
|
|
|
|
if ( $_POST['_subscription_trial_length'] > $max_trial_length ) {
|
|
$_POST['_subscription_trial_length'] = $max_trial_length;
|
|
}
|
|
|
|
update_post_meta( $post_id, '_subscription_trial_length', $_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',
|
|
);
|
|
|
|
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 array 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 2.0
|
|
*/
|
|
public static function save_variable_subscription_meta( $post_id ) {
|
|
|
|
if ( self::$saved_product_meta || ( empty( $_POST['_wcsnonce'] ) || ! wp_verify_nonce( $_POST['_wcsnonce'], 'wcs_subscription_meta' ) || ! isset( $_POST['product-type'] ) || ! in_array( $_POST['product-type'], 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.
|
|
* @return null
|
|
* @since 1.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 = 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 = 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 = 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 = 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 = 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
|
|
* @return null
|
|
* @since 1.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( $_POST['_wcsnonce'], 'wcs_subscription_meta' ) ) {
|
|
return;
|
|
}
|
|
|
|
// Make sure WooCommerce calculates correct prices
|
|
$_POST['variable_regular_price'] = isset( $_POST['variable_subscription_price'] ) ? $_POST['variable_subscription_price'] : 0;
|
|
|
|
// Sync the min variation price
|
|
if ( WC_Subscriptions::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 $i
|
|
* return void
|
|
* @since 2.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( $_POST['_wcsnonce_save_variations'], 'wcs_subscription_variations' ) ) {
|
|
return;
|
|
}
|
|
|
|
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 = count( $subscription_ranges[ $_POST['variable_subscription_trial_period'][ $index ] ] ) - 1;
|
|
|
|
$_POST['variable_subscription_trial_length'][ $index ] = absint( $_POST['variable_subscription_trial_length'][ $index ] );
|
|
|
|
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_sign_up_fee',
|
|
'_subscription_period',
|
|
'_subscription_period_interval',
|
|
'_subscription_length',
|
|
'_subscription_trial_period',
|
|
'_subscription_trial_length',
|
|
);
|
|
|
|
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 saved
|
|
*
|
|
* @return null
|
|
* @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( $_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 ) {
|
|
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
|
|
* @return null
|
|
*/
|
|
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.
|
|
*
|
|
* @param array 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
|
|
*/
|
|
public static function enqueue_styles_scripts() {
|
|
global $post;
|
|
|
|
// Get admin screen id
|
|
$screen = get_current_screen();
|
|
|
|
$is_woocommerce_screen = ( in_array( $screen->id, array( 'product', 'edit-shop_order', 'shop_order', 'edit-shop_subscription', 'shop_subscription', 'users', 'woocommerce_page_wc-settings' ) ) ) ? true : false;
|
|
$is_activation_screen = ( get_transient( WC_Subscriptions::$activation_transient ) == true ) ? true : false;
|
|
|
|
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::$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' ),
|
|
'oneTimeShippingCheckNonce' => wp_create_nonce( 'one_time_shipping' ),
|
|
);
|
|
} else if ( '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,
|
|
);
|
|
} else if ( 'shop_order' == $screen->id ) {
|
|
$dependencies[] = $woocommerce_admin_script_handle;
|
|
$dependencies[] = 'wc-admin-order-meta-boxes';
|
|
|
|
if ( WC_Subscriptions::is_woocommerce_pre( '2.6' ) ) {
|
|
$dependencies[] = 'wc-admin-order-meta-boxes-modal';
|
|
}
|
|
|
|
$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,
|
|
);
|
|
} else if ( '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' ),
|
|
);
|
|
}
|
|
|
|
$script_params['ajaxLoaderImage'] = WC()->plugin_url() . '/assets/images/ajax-loader.gif';
|
|
$script_params['ajaxUrl'] = admin_url( 'admin-ajax.php' );
|
|
$script_params['isWCPre24'] = var_export( WC_Subscriptions::is_woocommerce_pre( '2.4' ), true );
|
|
|
|
wp_enqueue_script( 'woocommerce_subscriptions_admin', plugin_dir_url( WC_Subscriptions::$plugin_file ) . 'assets/js/admin/admin.js', $dependencies, filemtime( plugin_dir_path( 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', plugin_dir_url( WC_Subscriptions::$plugin_file ) . 'assets/js/admin/admin-pointers.js', $dependencies, WC_Subscriptions::$version );
|
|
|
|
wp_localize_script( 'woocommerce_subscriptions_admin_pointers', 'WCSPointers', apply_filters( 'woocommerce_subscriptions_admin_pointer_script_parameters', $pointer_script_params ) );
|
|
|
|
wp_enqueue_style( 'wp-pointer' );
|
|
}
|
|
}
|
|
|
|
// Maybe add the admin notice
|
|
if ( $is_activation_screen ) {
|
|
|
|
$woocommerce_plugin_dir_file = self::get_woocommerce_plugin_dir_file();
|
|
|
|
if ( ! empty( $woocommerce_plugin_dir_file ) ) {
|
|
|
|
wp_enqueue_style( 'woocommerce-activation', plugins_url( '/assets/css/activation.css', self::get_woocommerce_plugin_dir_file() ), array(), WC_Subscriptions::$version );
|
|
|
|
if ( ! isset( $_GET['page'] ) || 'wcs-about' != $_GET['page'] ) {
|
|
add_action( 'admin_notices', __CLASS__ . '::admin_installed_notice' );
|
|
}
|
|
}
|
|
delete_transient( WC_Subscriptions::$activation_transient );
|
|
}
|
|
|
|
if ( $is_woocommerce_screen || $is_activation_screen || 'edit-product' == $screen->id ) {
|
|
wp_enqueue_style( 'woocommerce_admin_styles', WC()->plugin_url() . '/assets/css/admin.css', array(), WC_Subscriptions::$version );
|
|
wp_enqueue_style( 'woocommerce_subscriptions_admin', plugin_dir_url( WC_Subscriptions::$plugin_file ) . '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
|
|
*/
|
|
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
|
|
*/
|
|
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( $_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.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.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.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.3.1
|
|
*/
|
|
public static function get_subscriptions_list_table() {
|
|
|
|
if ( ! isset( self::$subscriptions_list_table ) ) {
|
|
|
|
if ( ! class_exists( 'WC_Subscriptions_List_Table' ) ) {
|
|
require_once( 'class-wc-subscriptions-list-table.php' );
|
|
}
|
|
|
|
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
|
|
*/
|
|
public static function update_subscription_settings() {
|
|
|
|
if ( empty( $_POST['_wcsnonce'] ) || ! wp_verify_nonce( $_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' ] );
|
|
}
|
|
|
|
woocommerce_update_options( self::get_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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
public static function add_default_settings() {
|
|
foreach ( self::get_settings() as $setting ) {
|
|
if ( isset( $setting['default'] ) ) {
|
|
add_option( $setting['id'], $setting['default'] );
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
public static function get_settings() {
|
|
if ( ! function_exists( 'get_editable_roles' ) ) {
|
|
require_once( ABSPATH . 'wp-admin/includes/user.php' );
|
|
}
|
|
|
|
$roles = get_editable_roles();
|
|
|
|
foreach ( $roles as $role => $details ) {
|
|
$roles_options[ $role ] = translate_user_role( $details['name'] );
|
|
}
|
|
|
|
return apply_filters( 'woocommerce_subscription_settings', array(
|
|
|
|
array(
|
|
'name' => __( 'Button Text', 'woocommerce-subscriptions' ),
|
|
'type' => 'title',
|
|
'desc' => '',
|
|
'id' => self::$option_prefix . '_button_text',
|
|
),
|
|
|
|
array(
|
|
'name' => __( 'Add to Cart Button Text', 'woocommerce-subscriptions' ),
|
|
'desc' => __( 'A product displays a button with the text "Add to Cart". By default, a subscription changes this to "Sign Up Now". You can customise the button text for subscriptions here.', 'woocommerce-subscriptions' ),
|
|
'tip' => '',
|
|
'id' => self::$option_prefix . '_add_to_cart_button_text',
|
|
'css' => 'min-width:150px;',
|
|
'default' => __( 'Sign Up Now', 'woocommerce-subscriptions' ),
|
|
'type' => 'text',
|
|
'desc_tip' => true,
|
|
),
|
|
|
|
array(
|
|
'name' => __( 'Place Order Button Text', 'woocommerce-subscriptions' ),
|
|
'desc' => __( 'Use this field to customise the text displayed on the checkout button when an order contains a subscription. Normally the checkout submission button displays "Place Order". When the cart contains a subscription, this is changed to "Sign Up Now".', 'woocommerce-subscriptions' ),
|
|
'tip' => '',
|
|
'id' => self::$option_prefix . '_order_button_text',
|
|
'css' => 'min-width:150px;',
|
|
'default' => __( 'Sign Up Now', 'woocommerce-subscriptions' ),
|
|
'type' => 'text',
|
|
'desc_tip' => true,
|
|
),
|
|
|
|
array( 'type' => 'sectionend', 'id' => self::$option_prefix . '_button_text' ),
|
|
|
|
array(
|
|
'name' => __( 'Roles', 'woocommerce-subscriptions' ),
|
|
'type' => 'title',
|
|
// translators: placeholders are <em> tags
|
|
'desc' => sprintf( __( 'Choose the default roles to assign to active and inactive subscribers. For record keeping purposes, a user account must be created for subscribers. Users with the %sadministrator%s role, such as yourself, will never be allocated these roles to prevent locking out administrators.', 'woocommerce-subscriptions' ), '<em>', '</em>' ),
|
|
'id' => self::$option_prefix . '_role_options',
|
|
),
|
|
|
|
array(
|
|
'name' => __( 'Subscriber Default Role', 'woocommerce-subscriptions' ),
|
|
'desc' => __( 'When a subscription is activated, either manually or after a successful purchase, new users will be assigned this role.', 'woocommerce-subscriptions' ),
|
|
'tip' => '',
|
|
'id' => self::$option_prefix . '_subscriber_role',
|
|
'css' => 'min-width:150px;',
|
|
'default' => 'subscriber',
|
|
'type' => 'select',
|
|
'options' => $roles_options,
|
|
'desc_tip' => true,
|
|
),
|
|
|
|
array(
|
|
'name' => __( 'Inactive Subscriber Role', 'woocommerce-subscriptions' ),
|
|
'desc' => __( 'If a subscriber\'s subscription is manually cancelled or expires, she will be assigned this role.', 'woocommerce-subscriptions' ),
|
|
'tip' => '',
|
|
'id' => self::$option_prefix . '_cancelled_role',
|
|
'css' => 'min-width:150px;',
|
|
'default' => 'customer',
|
|
'type' => 'select',
|
|
'options' => $roles_options,
|
|
'desc_tip' => true,
|
|
),
|
|
|
|
array( 'type' => 'sectionend', 'id' => self::$option_prefix . '_role_options' ),
|
|
|
|
array(
|
|
'name' => _x( 'Renewals', 'option section heading', 'woocommerce-subscriptions' ),
|
|
'type' => 'title',
|
|
'desc' => '',
|
|
'id' => self::$option_prefix . '_renewal_options',
|
|
),
|
|
|
|
array(
|
|
'name' => __( 'Manual Renewal Payments', 'woocommerce-subscriptions' ),
|
|
'desc' => __( 'Accept Manual Renewals', 'woocommerce-subscriptions' ),
|
|
'id' => self::$option_prefix . '_accept_manual_renewals',
|
|
'default' => 'no',
|
|
'type' => 'checkbox',
|
|
// translators: placeholders are opening and closing link tags
|
|
'desc_tip' => sprintf( __( 'With manual renewals, a customer\'s subscription is put on-hold until they login and pay to renew it. %sLearn more%s.', 'woocommerce-subscriptions' ), '<a href="http://docs.woocommerce.com/document/subscriptions/store-manager-guide/#accept-manual-renewals">', '</a>' ),
|
|
'checkboxgroup' => 'start',
|
|
'show_if_checked' => 'option',
|
|
),
|
|
|
|
array(
|
|
'desc' => __( 'Turn off Automatic Payments', 'woocommerce-subscriptions' ),
|
|
'id' => self::$option_prefix . '_turn_off_automatic_payments',
|
|
'default' => 'no',
|
|
'type' => 'checkbox',
|
|
// translators: placeholders are opening and closing link tags
|
|
'desc_tip' => sprintf( __( 'If you don\'t want new subscription purchases to automatically charge renewal payments, you can turn off automatic payments. Existing automatic subscriptions will continue to charge customers automatically. %sLearn more%s.', 'woocommerce-subscriptions' ), '<a href="http://docs.woocommerce.com/document/subscriptions/store-manager-guide/#turn-off-automatic-payments">', '</a>' ),
|
|
'checkboxgroup' => 'end',
|
|
'show_if_checked' => 'yes',
|
|
),
|
|
|
|
array( 'type' => 'sectionend', 'id' => self::$option_prefix . '_renewal_options' ),
|
|
|
|
array(
|
|
'name' => _x( 'Miscellaneous', 'options section heading', 'woocommerce-subscriptions' ),
|
|
'type' => 'title',
|
|
'desc' => '',
|
|
'id' => self::$option_prefix . '_miscellaneous',
|
|
),
|
|
|
|
array(
|
|
'name' => __( 'Customer Suspensions', 'woocommerce-subscriptions' ),
|
|
'desc' => _x( 'suspensions per billing period.', 'there\'s a number immediately in front of this text', 'woocommerce-subscriptions' ),
|
|
'id' => self::$option_prefix . '_max_customer_suspensions',
|
|
'css' => 'min-width:50px;',
|
|
'default' => 0,
|
|
'type' => 'select',
|
|
'options' => apply_filters( 'woocommerce_subscriptions_max_customer_suspension_range', array_merge( range( 0, 12 ), array( 'unlimited' => 'Unlimited' ) ) ),
|
|
'desc_tip' => __( 'Set a maximum number of times a customer can suspend their account for each billing period. For example, for a value of 3 and a subscription billed yearly, if the customer has suspended their account 3 times, they will not be presented with the option to suspend their account until the next year. Store managers will always be able to suspend an active subscription. Set this to 0 to turn off the customer suspension feature completely.', 'woocommerce-subscriptions' ),
|
|
),
|
|
|
|
array(
|
|
'name' => __( 'Mixed Checkout', 'woocommerce-subscriptions' ),
|
|
'desc' => __( 'Allow subscriptions and products to be purchased simultaneously.', 'woocommerce-subscriptions' ),
|
|
'id' => self::$option_prefix . '_multiple_purchase',
|
|
'default' => 'no',
|
|
'type' => 'checkbox',
|
|
'desc_tip' => __( 'Allow subscriptions and products to be purchased in a single transaction.', 'woocommerce-subscriptions' ),
|
|
),
|
|
|
|
array(
|
|
'name' => __( 'Drip Downloadable Content', 'woocommerce-subscriptions' ),
|
|
'desc' => __( 'Enable dripping for downloadable content on subscription products.', 'woocommerce-subscriptions' ),
|
|
'id' => self::$option_prefix . '_drip_downloadable_content_on_renewal',
|
|
'default' => 'no',
|
|
'type' => 'checkbox',
|
|
'desc_tip' => sprintf( __( 'Enabling this grants access to new downloadable files added to a product only after the next renewal is processed.%sBy default, access to new downloadable files added to a product is granted immediately to any customer that has an active subscription with that product.', 'woocommerce-subscriptions' ), '<br />' ),
|
|
),
|
|
|
|
array( 'type' => 'sectionend', 'id' => self::$option_prefix . '_miscellaneous' ),
|
|
) );
|
|
|
|
}
|
|
|
|
/**
|
|
* Displays instructional information for a WooCommerce setting.
|
|
*
|
|
* @since 1.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'] ) ) );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Outputs a welcome message. Called when the Subscriptions extension is activated.
|
|
*
|
|
* @since 1.0
|
|
*/
|
|
public static function admin_installed_notice() {
|
|
?>
|
|
<div id="message" class="updated woocommerce-message wc-connect woocommerce-subscriptions-activated">
|
|
<div class="squeezer">
|
|
<h4>
|
|
<?php
|
|
// translators: $1-$2: opening and closing <strong> tags, $3-$4: opening and closing <em> tags
|
|
echo wp_kses( sprintf( __( '%1$sWooCommerce Subscriptions Installed%2$s – %3$sYou\'re ready to start selling subscriptions!%4$s', 'woocommerce-subscriptions' ), '<strong>', '</strong>', '<em>', '</em>' ), array( 'strong' => true, 'em' => true ) );
|
|
?>
|
|
</h4>
|
|
|
|
<p class="submit">
|
|
<a href="<?php echo esc_url( self::add_subscription_url() ); ?>" class="button button-primary"><?php esc_html_e( 'Add a Subscription Product', 'woocommerce-subscriptions' ); ?></a>
|
|
<a href="<?php echo esc_url( self::settings_tab_url() ); ?>" class="docs button button-primary"><?php esc_html_e( 'Settings', 'woocommerce-subscriptions' ); ?></a>
|
|
<a href="https://twitter.com/share" class="twitter-share-button" data-url="http://www.woocommerce.com/products/woocommerce-subscriptions/" data-text="Woot! I can sell subscriptions with #WooCommerce" data-via="WooCommerce" data-size="large">Tweet</a>
|
|
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<?php
|
|
}
|
|
|
|
/**
|
|
* Checks whether a user should be shown pointers or not, based on whether a user has previously dismissed pointers.
|
|
*
|
|
* @since 1.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
|
|
*/
|
|
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;
|
|
}
|
|
|
|
/**
|
|
* Searches through the list of active plugins to find WooCommerce. Just in case
|
|
* WooCommerce resides in a folder other than /woocommerce/
|
|
*
|
|
* @since 1.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
|
|
* @param string $request
|
|
* @return string
|
|
* @since 2.0
|
|
*/
|
|
public static function filter_orders( $where ) {
|
|
global $typenow, $wpdb;
|
|
|
|
if ( is_admin() && 'shop_order' == $typenow ) {
|
|
|
|
$related_orders = array();
|
|
|
|
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;
|
|
}
|
|
|
|
/**
|
|
* Display a notice indicating that the "Orders" list is filtered.
|
|
* @see self::filter_orders()
|
|
*/
|
|
public static function display_renewal_filter_notice() {
|
|
|
|
global $wp_version;
|
|
|
|
$query_arg = '_subscription_related_orders';
|
|
|
|
if ( isset( $_GET[ $query_arg ] ) && $_GET[ $query_arg ] > 0 && true === self::$found_related_orders ) {
|
|
|
|
$initial_order = new WC_Order( absint( $_GET[ $query_arg ] ) );
|
|
|
|
if ( version_compare( $wp_version, '4.2', '<' ) ) {
|
|
echo '<div class="updated"><p>';
|
|
printf(
|
|
'<a href="%1$s" class="close-subscriptions-search">×</a>',
|
|
esc_url( remove_query_arg( $query_arg ) )
|
|
);
|
|
// translators: placeholders are opening link tag, ID of sub, and closing link tag
|
|
printf( esc_html__( 'Showing orders for %sSubscription %s%s', 'woocommerce-subscriptions' ), '<a href="' . esc_url( get_edit_post_link( absint( $_GET[ $query_arg ] ) ) ) . '">', esc_html( $initial_order->get_order_number() ), '</a>' );
|
|
echo '</p>';
|
|
} else {
|
|
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 %sSubscription %s%s', 'woocommerce-subscriptions' ), '<a href="' . esc_url( get_edit_post_link( absint( $_GET[ $query_arg ] ) ) ) . '">', esc_html( $initial_order->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( $query_arg ) )
|
|
);
|
|
}
|
|
|
|
echo '</div>';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns either a string or array of strings describing the allowable trial period range
|
|
* for a subscription.
|
|
*
|
|
* @since 1.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: %1s, %2s, %3s or %4s.', '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 );
|
|
}
|
|
|
|
/**
|
|
* Callback for the [subscriptions] shortcode that displays subscription names for a particular user.
|
|
*
|
|
* @param array $attributes Shortcode attributes.
|
|
* @return string
|
|
*/
|
|
public static function do_subscriptions_shortcode( $attributes ) {
|
|
$attributes = wp_parse_args(
|
|
$attributes,
|
|
array(
|
|
'user_id' => 0,
|
|
'status' => 'active',
|
|
)
|
|
);
|
|
|
|
$subscriptions = wcs_get_users_subscriptions( $attributes['user_id'] );
|
|
|
|
if ( empty( $subscriptions ) ) {
|
|
return '<ul class="user-subscriptions no-user-subscriptions">
|
|
<li>' . esc_html_x( 'No subscriptions found.', 'in [subscriptions] shortcode', 'woocommerce-subscriptions' ) . '</li>
|
|
</ul>';
|
|
}
|
|
|
|
$list = '<ul class="user-subscriptions">';
|
|
|
|
foreach ( $subscriptions as $subscription ) {
|
|
if ( 'all' == $attributes['status'] || $subscription->has_status( $attributes['status'] ) ) {
|
|
// translators: order number
|
|
$shortcode_translate = sprintf( esc_html_x( 'Subscription %s', 'in [subscriptions] shortcode', 'woocommerce-subscriptions' ), $subscription->get_order_number() );
|
|
$list .= sprintf( '<li><a href="%s">%s</a></li>', $subscription->get_view_order_url(), $shortcode_translate );
|
|
}
|
|
}
|
|
$list .= '</ul>';
|
|
|
|
return $list;
|
|
}
|
|
|
|
/**
|
|
* Renders the Subscription information in the WC status page
|
|
*/
|
|
public static function render_system_status_items() {
|
|
$debug_data = array();
|
|
$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>' . ( ( WC_Subscriptions::is_duplicate_site() ) ? _x( 'Staging', 'refers to staging site', 'woocommerce-subscriptions' ) : _x( 'Live', 'refers to live site', 'woocommerce-subscriptions' ) ) . '</strong>',
|
|
'success' => ( WC_Subscriptions::is_duplicate_site() ) ? 0 : 1,
|
|
);
|
|
|
|
$debug_data = apply_filters( 'wcs_system_status', $debug_data );
|
|
|
|
include( plugin_dir_path( WC_Subscriptions::$plugin_file ) . 'templates/admin/status.php' );
|
|
}
|
|
|
|
/**
|
|
* Adds Subscriptions specific details to the WooCommerce System Status report.
|
|
*
|
|
* @param array $attributes Shortcode attributes.
|
|
* @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>' . ( ( WC_Subscriptions::is_duplicate_site() ) ? _x( 'Staging', 'refers to staging site', 'woocommerce-subscriptions' ) : _x( 'Live', 'refers to live site', 'woocommerce-subscriptions' ) ) . '</strong>',
|
|
'success' => ( WC_Subscriptions::is_duplicate_site() ) ? 0 : 1,
|
|
);
|
|
|
|
return $debug_data;
|
|
}
|
|
|
|
/**
|
|
* A WooCommerce version aware function for getting the Subscriptions admin settings
|
|
* tab URL.
|
|
*
|
|
* @since 1.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.
|
|
*
|
|
* @since 1.5
|
|
* @return string
|
|
*/
|
|
public static function payment_gateways_rewewal_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;
|
|
}
|
|
|
|
/**
|
|
* 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.5
|
|
*/
|
|
public static function payment_gateways_rewewal_support( $gateway ) {
|
|
|
|
echo '<td class="renewals">';
|
|
if ( ( is_array( $gateway->supports ) && in_array( 'subscriptions', $gateway->supports ) ) || $gateway->id == 'paypal' ) {
|
|
$status_html = '<span class="status-enabled tips" data-tip="' . esc_attr__( 'Supports automatic renewal payments with the WooCommerce Subscriptions extension.', '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 2.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>';
|
|
}
|
|
|
|
/**
|
|
* Do not display formatted order total on the Edit Order administration screen
|
|
*
|
|
* @since 1.5.17
|
|
*/
|
|
public static function maybe_remove_formatted_order_total_filter( $formatted_total, $order ) {
|
|
|
|
// Check if we're on the Edit Order screen - get_current_screen() only exists on admin pages so order of operations matters here
|
|
if ( is_admin() && function_exists( 'get_current_screen' ) ) {
|
|
|
|
$screen = get_current_screen();
|
|
|
|
if ( is_object( $screen ) && 'shop_order' == $screen->id ) {
|
|
remove_filter( 'woocommerce_get_formatted_order_total', 'WC_Subscriptions_Order::get_formatted_order_total', 10, 2 );
|
|
}
|
|
}
|
|
|
|
return $formatted_total;
|
|
}
|
|
|
|
/**
|
|
* Only attach the gettext callback when on admin shop subscription screen
|
|
*
|
|
* @since 2.2.7
|
|
*/
|
|
public static function maybe_attach_gettext_callback() {
|
|
|
|
$screen = get_current_screen();
|
|
|
|
if ( is_object( $screen ) && 'shop_subscription' == $screen->id ) {
|
|
add_filter( 'gettext', __CLASS__ . '::change_order_item_editable_text', 10, 3 );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Only unattach the gettext callback when it was attached
|
|
*
|
|
* @since 2.2.7
|
|
*/
|
|
public static function maybe_unattach_gettext_callback() {
|
|
|
|
$screen = get_current_screen();
|
|
|
|
if ( is_object( $screen ) && 'shop_subscription' == $screen->id ) {
|
|
remove_filter( 'gettext', __CLASS__ . '::change_order_item_editable_text', 10, 3 );
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* When subscription items not editable (such as due to the payment gateway not supporting modifications),
|
|
* change the text to explain why
|
|
*
|
|
* @since 2.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"':
|
|
$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->Checkout->Payment Gateways table.
|
|
* This includes links to find additional gateways, information about manual renewals
|
|
* and a warning if no payment gateway which supports automatic recurring payments is enabled/setup correctly.
|
|
*
|
|
* @since 2.1
|
|
*/
|
|
public static function add_recurring_payment_gateway_information( $settings ) {
|
|
$available_gateways_description = '';
|
|
|
|
if ( ! WC_Subscriptions_Payment_Gateways::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 the %1$sfree Stripe extension%2$s.', 'woocommerce-subscriptions' ), '<strong><a href="https://www.woocommerce.com/products/stripe/">', '</a></strong>' );
|
|
}
|
|
|
|
$recurring_payment_settings = array(
|
|
array(
|
|
'name' => __( 'Recurring Payments', 'woocommerce-subscriptions' ),
|
|
'desc' => $available_gateways_description,
|
|
'id' => WC_Subscriptions_Admin::$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 %smanual subscription renewal payments%s.', 'woocommerce-subscriptions' ), '<a href="http://docs.woocommerce.com/document/subscriptions/renewal-process/">', '</a>' ),
|
|
'id' => WC_Subscriptions_Admin::$option_prefix . '_payment_gateways_additional',
|
|
'type' => 'informational',
|
|
),
|
|
|
|
array(
|
|
// translators: $1-$2: opening and closing tags. Link to documents->payment gateways, 3$-4$: opening and closing tags. Link to WooCommerce extensions shop page
|
|
'desc' => sprintf( __( 'Find new gateways that %1$ssupport automatic subscription payments%2$s in the official %3$sWooCommerce Marketplace%4$s.', 'woocommerce-subscriptions' ), '<a href="' . esc_url( 'http://docs.woocommerce.com/document/subscriptions/payment-gateways/' ) . '">', '</a>', '<a href="' . esc_url( 'http://www.woocommerce.com/product-category/woocommerce-extensions/' ) . '">', '</a>' ),
|
|
'id' => WC_Subscriptions_Admin::$option_prefix . '_payment_gateways_additional',
|
|
'type' => 'informational',
|
|
),
|
|
);
|
|
|
|
$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;
|
|
}
|
|
|
|
/**
|
|
* 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();
|
|
}
|
|
|
|
/**
|
|
* 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 Subcsription
|
|
*
|
|
* @since 1.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.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 2.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' );
|
|
}
|
|
}
|
|
|
|
WC_Subscriptions_Admin::init();
|