mirror of
https://github.com/pronamic/woocommerce-subscriptions.git
synced 2025-10-14 13:22:55 +00:00
800 lines
32 KiB
PHP
800 lines
32 KiB
PHP
<?php
|
|
/**
|
|
* WooCommerce Subscriptions Admin Meta Boxes
|
|
*
|
|
* Sets up the write panels used by the subscription custom order/post type
|
|
*
|
|
* @category Admin
|
|
* @package WooCommerce Subscriptions/Admin
|
|
* @version 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
|
|
*/
|
|
|
|
if ( ! defined( 'ABSPATH' ) ) {
|
|
exit; // Exit if accessed directly
|
|
}
|
|
|
|
/**
|
|
* WC_Admin_Meta_Boxes
|
|
*/
|
|
class WCS_Admin_Meta_Boxes {
|
|
|
|
/**
|
|
* Constructor
|
|
*/
|
|
public function __construct() {
|
|
|
|
add_action( 'add_meta_boxes', array( $this, 'add_meta_boxes' ), 25, 2 );
|
|
|
|
add_action( 'add_meta_boxes', array( $this, 'remove_meta_boxes' ), 35 );
|
|
|
|
// We need to remove core WC save methods for meta boxes we don't use
|
|
add_action( 'woocommerce_process_shop_order_meta', array( $this, 'remove_meta_box_save' ), -1, 2 );
|
|
|
|
add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_styles_scripts' ), 20 );
|
|
|
|
// We need to hook to the 'shop_order' rather than 'shop_subscription' because we declared that the 'shop_subscription' order type supports 'order-meta-boxes'.
|
|
add_action( 'woocommerce_process_shop_order_meta', 'WCS_Meta_Box_Schedule::save', 10, 2 );
|
|
add_action( 'woocommerce_process_shop_order_meta', 'WCS_Meta_Box_Subscription_Data::save', 10, 2 );
|
|
|
|
add_filter( 'woocommerce_order_actions', array( __CLASS__, 'add_subscription_actions' ), 10, 1 );
|
|
|
|
add_action( 'woocommerce_order_action_wcs_process_renewal', array( __CLASS__, 'process_renewal_action_request' ), 10, 1 );
|
|
add_action( 'woocommerce_order_action_wcs_create_pending_renewal', array( __CLASS__, 'create_pending_renewal_action_request' ), 10, 1 );
|
|
add_action( 'woocommerce_order_action_wcs_create_pending_parent', array( __CLASS__, 'create_pending_parent_action_request' ), 10, 1 );
|
|
|
|
if ( wcs_is_woocommerce_pre( '3.2' ) ) {
|
|
add_filter( 'woocommerce_resend_order_emails_available', array( __CLASS__, 'remove_order_email_actions' ), 0, 1 );
|
|
}
|
|
|
|
add_action( 'woocommerce_order_action_wcs_retry_renewal_payment', array( __CLASS__, 'process_retry_renewal_payment_action_request' ), 10, 1 );
|
|
|
|
// Disable stock management while adding line items to a subscription via AJAX.
|
|
add_action( 'option_woocommerce_manage_stock', array( __CLASS__, 'override_stock_management' ) );
|
|
|
|
// Parent order line item price lock option.
|
|
add_action( 'woocommerce_order_item_add_action_buttons', array( __CLASS__, 'output_price_lock_html' ) );
|
|
add_action( 'woocommerce_process_shop_order_meta', array( __CLASS__, 'save_increased_price_lock' ) );
|
|
add_action( 'wp_ajax_wcs_order_price_lock', array( __CLASS__, 'save_increased_price_lock' ) );
|
|
|
|
// After calculating subscription/renewal order line item taxes, update base location tax item meta.
|
|
add_action( 'woocommerce_ajax_add_order_item_meta', array( __CLASS__, 'store_item_base_location_tax' ), 10, 3 );
|
|
|
|
// Prevent WC core's stock handling when saving the line item meta box for subscriptions.
|
|
add_filter( 'woocommerce_prevent_adjust_line_item_product_stock', array( __CLASS__, 'prevent_subscription_line_item_stock_handling' ), 10, 2 );
|
|
|
|
add_action( 'woocommerce_before_save_order_items', array( __CLASS__, 'update_subtracted_base_location_tax_meta' ), 10, 2 );
|
|
|
|
add_action( 'woocommerce_before_save_order_items', array( __CLASS__, 'update_subtracted_base_location_taxes_amount' ), 10, 2 );
|
|
|
|
add_action( 'wp_ajax_wcs_get_customer_orders', array( __CLASS__, 'get_customer_orders' ) );
|
|
}
|
|
|
|
/**
|
|
* Add WC Meta boxes
|
|
*
|
|
* @see add_meta_boxes
|
|
*
|
|
* @param string $post_type The post type of the current post being edited.
|
|
* @param WP_Post|WC_Order|null $post_or_order_object The post or order currently being edited.
|
|
*/
|
|
public function add_meta_boxes( $post_type = '', $post_or_order_object = null ) {
|
|
$subscriptions_screen_id = wcs_get_page_screen_id( 'shop_subscription' );
|
|
|
|
add_meta_box( 'woocommerce-subscription-data', _x( 'Subscription Data', 'meta box title', 'woocommerce-subscriptions' ), 'WCS_Meta_Box_Subscription_Data::output', $subscriptions_screen_id, 'normal', 'high' );
|
|
|
|
add_meta_box( 'woocommerce-subscription-schedule', _x( 'Schedule', 'meta box title', 'woocommerce-subscriptions' ), 'WCS_Meta_Box_Schedule::output', $subscriptions_screen_id, 'side', 'default' );
|
|
|
|
remove_meta_box( 'woocommerce-order-data', $subscriptions_screen_id, 'normal' );
|
|
|
|
add_meta_box( 'subscription_renewal_orders', __( 'Related Orders', 'woocommerce-subscriptions' ), 'WCS_Meta_Box_Related_Orders::output', $subscriptions_screen_id, 'normal', 'low' );
|
|
|
|
// Ensure backwards compatibility if $post_or_order_object not provided and is 'shop_order' post type.
|
|
if ( ! $post_or_order_object && 'shop_order' === $post_type ) {
|
|
global $post_ID;
|
|
$post_or_order_object = wc_get_order( $post_ID );
|
|
}
|
|
|
|
// Get "Edit Order" screen ID, which differs if HPOS is enabled.
|
|
$order_screen_id = wcs_get_page_screen_id( 'shop_order' );
|
|
$current_screen = get_current_screen();
|
|
|
|
// Only display the meta box if viewing an order that contains a subscription.
|
|
if ( $post_or_order_object && $current_screen && $current_screen->id === $order_screen_id && wcs_order_contains_subscription( $post_or_order_object, 'any' ) ) {
|
|
add_meta_box( 'subscription_renewal_orders', __( 'Related Orders', 'woocommerce-subscriptions' ), 'WCS_Meta_Box_Related_Orders::output', $order_screen_id, 'normal', 'low' );
|
|
}
|
|
|
|
// On HPOS environments we need to remove and readd the line items meta box so it appears after the subscription data.
|
|
if ( wcs_is_custom_order_tables_usage_enabled() ) {
|
|
self::reorder_subscription_line_items_meta_box();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Removes the core Order Data meta box as we add our own Subscription Data meta box
|
|
*/
|
|
public function remove_meta_boxes() {
|
|
remove_meta_box( 'woocommerce-order-data', 'shop_subscription', 'normal' );
|
|
}
|
|
|
|
/**
|
|
* Don't save some order related meta boxes.
|
|
*
|
|
* @see woocommerce_process_shop_order_meta
|
|
*
|
|
* @param int $order_id
|
|
* @param WC_Order $order
|
|
*/
|
|
public function remove_meta_box_save( $order_id, $order ) {
|
|
if ( wcs_is_subscription( $order_id ) ) {
|
|
remove_action( 'woocommerce_process_shop_order_meta', 'WC_Meta_Box_Order_Data::save', 40 );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Print admin styles/scripts
|
|
*/
|
|
public function enqueue_styles_scripts() {
|
|
global $theorder;
|
|
|
|
// Get admin screen ID.
|
|
$screen = get_current_screen();
|
|
$screen_id = isset( $screen->id ) ? $screen->id : '';
|
|
|
|
// Get the script version.
|
|
$ver = WC_Subscriptions_Core_Plugin::instance()->get_library_version();
|
|
|
|
if ( wcs_get_page_screen_id( 'shop_subscription' ) === $screen_id ) {
|
|
// If global $theorder is empty, fallback to using the global post object.
|
|
if ( empty( $theorder ) && ! empty( $GLOBALS['post']->ID ) ) {
|
|
$subscription = wcs_get_subscription( $GLOBALS['post']->ID );
|
|
|
|
// If we have a subscription, set it as the global $theorder.
|
|
if ( $subscription ) {
|
|
$theorder = $subscription;
|
|
}
|
|
} else {
|
|
$subscription = $theorder;
|
|
}
|
|
|
|
if ( ! wcs_is_subscription( $subscription ) ) {
|
|
return;
|
|
}
|
|
|
|
wp_register_script( 'jstz', WC_Subscriptions_Core_Plugin::instance()->get_subscriptions_core_directory_url( 'assets/js/admin/jstz.min.js' ), [], $ver, false );
|
|
wp_register_script( 'momentjs', WC_Subscriptions_Core_Plugin::instance()->get_subscriptions_core_directory_url( 'assets/js/admin/moment.min.js' ), [], $ver, false );
|
|
|
|
wp_enqueue_script( 'wcs-admin-meta-boxes-subscription', WC_Subscriptions_Core_Plugin::instance()->get_subscriptions_core_directory_url( 'assets/js/admin/meta-boxes-subscription.js' ), array( 'wc-admin-meta-boxes', 'jstz', 'momentjs' ), $ver, false );
|
|
|
|
wp_localize_script(
|
|
'wcs-admin-meta-boxes-subscription',
|
|
'wcs_admin_meta_boxes',
|
|
apply_filters(
|
|
'woocommerce_subscriptions_admin_meta_boxes_script_parameters',
|
|
array(
|
|
'i18n_start_date_notice' => __( 'Please enter a start date in the past.', 'woocommerce-subscriptions' ),
|
|
'i18n_past_date_notice' => WCS_Staging::is_duplicate_site() ? __( 'Please enter a date at least 2 minutes into the future.', 'woocommerce-subscriptions' ) : __( 'Please enter a date at least one hour into the future.', 'woocommerce-subscriptions' ),
|
|
'i18n_next_payment_start_notice' => __( 'Please enter a date after the trial end.', 'woocommerce-subscriptions' ),
|
|
'i18n_next_payment_trial_notice' => __( 'Please enter a date after the start date.', 'woocommerce-subscriptions' ),
|
|
'i18n_trial_end_start_notice' => __( 'Please enter a date after the start date.', 'woocommerce-subscriptions' ),
|
|
'i18n_trial_end_next_notice' => __( 'Please enter a date before the next payment.', 'woocommerce-subscriptions' ),
|
|
'i18n_end_date_notice' => __( 'Please enter a date after the next payment.', 'woocommerce-subscriptions' ),
|
|
'process_renewal_action_warning' => __( "Are you sure you want to process a renewal?\n\nThis will charge the customer and email them the renewal order (if emails are enabled).", 'woocommerce-subscriptions' ),
|
|
'payment_method' => $subscription->get_payment_method(),
|
|
'search_customers_nonce' => wp_create_nonce( 'search-customers' ),
|
|
'get_customer_orders_nonce' => wp_create_nonce( 'get-customer-orders' ),
|
|
'is_duplicate_site' => WCS_Staging::is_duplicate_site(),
|
|
)
|
|
)
|
|
);
|
|
} elseif ( 'shop_order' === $screen_id ) {
|
|
|
|
wp_enqueue_script( 'wcs-admin-meta-boxes-order', WC_Subscriptions_Core_Plugin::instance()->get_subscriptions_core_directory_url( 'assets/js/admin/wcs-meta-boxes-order.js' ), [], $ver, false );
|
|
|
|
wp_localize_script(
|
|
'wcs-admin-meta-boxes-order',
|
|
'wcs_admin_order_meta_boxes',
|
|
array(
|
|
'retry_renewal_payment_action_warning' => __( "Are you sure you want to retry payment for this renewal order?\n\nThis will attempt to charge the customer and send renewal order emails (if emails are enabled).", 'woocommerce-subscriptions' ),
|
|
)
|
|
);
|
|
} elseif ( in_array( $screen_id, array( 'shop_coupon', 'edit-shop_coupon' ), true ) ) {
|
|
wp_enqueue_script(
|
|
'wcs-admin-coupon-meta-boxes',
|
|
WC_Subscriptions_Core_Plugin::instance()->get_subscriptions_core_directory_url( 'assets/js/admin/meta-boxes-coupon.js' ),
|
|
array( 'jquery', 'wc-admin-meta-boxes' ),
|
|
$ver,
|
|
false
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Adds actions to the admin edit subscriptions page, if the subscription hasn't ended and the payment method supports them.
|
|
*
|
|
* @param array $actions An array of available actions
|
|
* @return array An array of updated actions
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
|
|
*/
|
|
public static function add_subscription_actions( $actions ) {
|
|
global $theorder;
|
|
|
|
if ( wcs_is_subscription( $theorder ) ) {
|
|
if ( ! wcs_is_woocommerce_pre( '3.2' ) ) {
|
|
unset( $actions['send_order_details'], $actions['send_order_details_admin'] );
|
|
}
|
|
|
|
if ( ! $theorder->has_status( wcs_get_subscription_ended_statuses() ) ) {
|
|
if ( $theorder->payment_method_supports( 'subscription_date_changes' ) && $theorder->has_status( 'active' ) ) {
|
|
$actions['wcs_process_renewal'] = esc_html__( 'Process renewal', 'woocommerce-subscriptions' );
|
|
}
|
|
|
|
if ( count( $theorder->get_related_orders() ) > 0 ) {
|
|
$actions['wcs_create_pending_renewal'] = esc_html__( 'Create pending renewal order', 'woocommerce-subscriptions' );
|
|
} else {
|
|
$actions['wcs_create_pending_parent'] = esc_html__( 'Create pending parent order', 'woocommerce-subscriptions' );
|
|
}
|
|
}
|
|
} elseif ( self::can_renewal_order_be_retried( $theorder ) ) {
|
|
$actions['wcs_retry_renewal_payment'] = esc_html__( 'Retry Renewal Payment', 'woocommerce-subscriptions' );
|
|
}
|
|
|
|
return $actions;
|
|
}
|
|
|
|
/**
|
|
* Handles the action request to process a renewal order.
|
|
*
|
|
* @param array $subscription
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
|
|
*/
|
|
public static function process_renewal_action_request( $subscription ) {
|
|
$subscription->add_order_note( __( 'Process renewal order action requested by admin.', 'woocommerce-subscriptions' ), false, true );
|
|
do_action( 'woocommerce_scheduled_subscription_payment', $subscription->get_id() );
|
|
}
|
|
|
|
/**
|
|
* Handles the action request to create a pending renewal order.
|
|
*
|
|
* @param WC_Subscription $subscription
|
|
*/
|
|
public static function create_pending_renewal_action_request( $subscription ) {
|
|
$subscription->add_order_note( __( 'Create pending renewal order requested by admin action.', 'woocommerce-subscriptions' ), false, true );
|
|
|
|
try {
|
|
$subscription->update_status( 'on-hold' );
|
|
} catch ( Exception $e ) {
|
|
wcs_add_admin_notice(
|
|
__( 'Pending renewal order was not created, as it was not possible to update the subscription status.', 'woocommerce-subscriptions' ),
|
|
'error'
|
|
);
|
|
return;
|
|
}
|
|
|
|
$renewal_order = wcs_create_renewal_order( $subscription );
|
|
|
|
if ( is_wp_error( $renewal_order ) ) {
|
|
self::notify(
|
|
$subscription,
|
|
'error',
|
|
esc_html__( 'Creation of the pending renewal order failed.', 'woocommerce-subscriptions' )
|
|
. ' ' . $renewal_order->get_error_message()
|
|
);
|
|
|
|
return;
|
|
}
|
|
|
|
if ( ! $subscription->is_manual() ) {
|
|
$renewal_url = $renewal_order->get_edit_order_url();
|
|
|
|
try {
|
|
// We need to pass the payment gateway instance to be compatible with WC < 3.0, only WC 3.0+ supports passing the string name.
|
|
$renewal_order->set_payment_method( wc_get_payment_gateway_by_order( $subscription ) );
|
|
|
|
if ( is_callable( array( $renewal_order, 'save' ) ) ) { // WC 3.0+
|
|
$renewal_order->save();
|
|
}
|
|
|
|
wcs_add_admin_notice(
|
|
sprintf(
|
|
/* Translators: %1$s opening link tag, %2$s closing link tag. */
|
|
esc_html__( 'A pending %1$srenewal order%2$s was successfully created!', 'woocommerce-subscriptions' ),
|
|
'<a href="' . esc_url( $renewal_url ) . '">',
|
|
'</a>'
|
|
),
|
|
'success'
|
|
);
|
|
} catch ( WC_Data_Exception $e ) {
|
|
self::notify(
|
|
$subscription,
|
|
'error',
|
|
sprintf(
|
|
/* Translators: %1$s opening link tag, %2$s closing link tag. */
|
|
esc_html__( 'A %1$spending renewal order%2$s was successfully created, but there was a problem setting the payment method. Please review the order.', 'woocommerce-subscriptions' ),
|
|
'<a href="' . esc_url( $renewal_url ) . '">',
|
|
'</a>'
|
|
)
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Handles the action request to create a pending parent order.
|
|
*
|
|
* @param array $subscription
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.3
|
|
*/
|
|
public static function create_pending_parent_action_request( $subscription ) {
|
|
|
|
if ( ! $subscription->has_status( array( 'pending', 'on-hold' ) ) ) {
|
|
$subscription->update_status( 'on-hold' );
|
|
}
|
|
|
|
$parent_order = wcs_create_order_from_subscription( $subscription, 'parent' );
|
|
|
|
$subscription->set_parent_id( wcs_get_objects_property( $parent_order, 'id' ) );
|
|
$subscription->save();
|
|
|
|
if ( ! $subscription->is_manual() ) {
|
|
|
|
$parent_order->set_payment_method( wc_get_payment_gateway_by_order( $subscription ) ); // We need to pass the payment gateway instance to be compatible with WC < 3.0, only WC 3.0+ supports passing the string name
|
|
|
|
if ( is_callable( array( $parent_order, 'save' ) ) ) { // WC 3.0+
|
|
$parent_order->save();
|
|
}
|
|
}
|
|
|
|
wc_maybe_reduce_stock_levels( $parent_order );
|
|
$subscription->add_order_note( __( 'Create pending parent order requested by admin action.', 'woocommerce-subscriptions' ), false, true );
|
|
}
|
|
|
|
/**
|
|
* Removes order related emails from the available actions.
|
|
*
|
|
* @param array $available_emails
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
|
|
*/
|
|
public static function remove_order_email_actions( $email_actions ) {
|
|
global $theorder;
|
|
|
|
if ( wcs_is_subscription( $theorder ) ) {
|
|
$email_actions = array();
|
|
}
|
|
|
|
return $email_actions;
|
|
}
|
|
|
|
/**
|
|
* Process the action request to retry renewal payment for failed renewal orders.
|
|
*
|
|
* @param WC_Order $order
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.1
|
|
*/
|
|
public static function process_retry_renewal_payment_action_request( $order ) {
|
|
|
|
if ( self::can_renewal_order_be_retried( $order ) ) {
|
|
// init payment gateways
|
|
WC()->payment_gateways();
|
|
|
|
$order->add_order_note( __( 'Retry renewal payment action requested by admin.', 'woocommerce-subscriptions' ), false, true );
|
|
do_action( 'woocommerce_scheduled_subscription_payment_' . wcs_get_objects_property( $order, 'payment_method' ), $order->get_total(), $order );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Determines if a renewal order payment can be retried. A renewal order payment can only be retried when:
|
|
* - Order is a renewal order
|
|
* - Order status is failed
|
|
* - Order payment method isn't empty
|
|
* - Order total > 0
|
|
* - Subscription/s aren't manual
|
|
* - Subscription payment method supports date changes
|
|
* - Order payment method has_action('woocommerce_scheduled_subscription_payment_..')
|
|
*
|
|
* @param WC_Order $order
|
|
* @return bool
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.1
|
|
*/
|
|
private static function can_renewal_order_be_retried( $order ) {
|
|
|
|
$can_be_retried = false;
|
|
|
|
if ( wcs_order_contains_renewal( $order ) && $order->needs_payment() && '' != wcs_get_objects_property( $order, 'payment_method' ) ) { // phpcs:ignore WordPress.PHP.StrictComparisons.LooseComparison
|
|
$supports_date_changes = false;
|
|
$order_payment_gateway = wc_get_payment_gateway_by_order( $order );
|
|
$order_payment_gateway_supports = ( isset( $order_payment_gateway->id ) ) ? has_action( 'woocommerce_scheduled_subscription_payment_' . $order_payment_gateway->id ) : false;
|
|
|
|
foreach ( wcs_get_subscriptions_for_renewal_order( $order ) as $subscription ) {
|
|
$supports_date_changes = $subscription->payment_method_supports( 'subscription_date_changes' );
|
|
$is_automatic = ! $subscription->is_manual();
|
|
break;
|
|
}
|
|
|
|
$can_be_retried = $order_payment_gateway_supports && $supports_date_changes && $is_automatic;
|
|
}
|
|
|
|
return $can_be_retried;
|
|
}
|
|
|
|
/**
|
|
* Disables stock management while adding items to a subscription via the edit subscription screen.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v3.0.6
|
|
*
|
|
* @param string $manage_stock The default manage stock setting.
|
|
* @return string Whether the stock should be managed.
|
|
*/
|
|
public static function override_stock_management( $manage_stock ) {
|
|
|
|
// Override stock management while adding line items to a subscription via AJAX.
|
|
if ( isset( $_POST['order_id'], $_REQUEST['security'] ) && wp_verify_nonce( wc_clean( wp_unslash( $_REQUEST['security'] ) ), 'order-item' ) && doing_action( 'wp_ajax_woocommerce_add_order_item' ) && wcs_is_subscription( absint( wp_unslash( $_POST['order_id'] ) ) ) ) {
|
|
$manage_stock = 'no';
|
|
}
|
|
|
|
return $manage_stock;
|
|
}
|
|
|
|
|
|
/**
|
|
* Displays a checkbox allowing admin to lock in prices increases in the edit order line items meta box.
|
|
*
|
|
* This checkbox is only displayed if the following criteria is met:
|
|
* - The order is unpaid.
|
|
* - The order is a subscription parent order. Renewal orders already lock in the subscription recurring price.
|
|
* - The order's currency matches the base store currency.
|
|
* - The order contains a line item with a subtotal greater than the product's current live price.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v3.0.10
|
|
*
|
|
* @param WC_Order $order The order being edited.
|
|
*/
|
|
public static function output_price_lock_html( $order ) {
|
|
|
|
if ( ! $order->needs_payment() || ! wcs_order_contains_subscription( $order, 'parent' ) ) {
|
|
return;
|
|
}
|
|
|
|
// If the order currency doesn't match the base currency we can't know if the order contains manually increased prices.
|
|
if ( $order->get_currency() !== get_woocommerce_currency() ) {
|
|
return;
|
|
}
|
|
|
|
$needs_price_lock = false;
|
|
|
|
foreach ( $order->get_items() as $line_item ) {
|
|
$product = $line_item->get_product();
|
|
|
|
// If the line item price is above the current live price.
|
|
if ( $product && ( $line_item->get_subtotal() / $line_item->get_quantity() ) > $product->get_price() ) {
|
|
$needs_price_lock = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if ( $needs_price_lock ) {
|
|
$help_tip = __( "This order contains line items with prices above the current product price. To override the product's live price when the customer pays for this order, lock in the manual price increases.", 'woocommerce-subscriptions' );
|
|
|
|
printf(
|
|
'<div id="wcs_order_price_lock"><label for="wcs-order-price-lock">%s</label>%s<input id="wcs-order-price-lock" type="checkbox" name="wcs_order_price_lock" value="yes" %s></div>',
|
|
esc_html__( 'Lock manual price increases', 'woocommerce-subscriptions' ),
|
|
// So the help tip is initialized when the line items are reloaded, we need to add the 'tips' class to the element.
|
|
// PHPCS warning ignored since escaping is handled by wc_help_tip().
|
|
wcs_help_tip( $help_tip, false, 'woocommerce-help-tip tips' ), // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
|
|
checked( $order->get_meta( '_manual_price_increases_locked' ), 'true', false )
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Saves the manual price increase lock via Edit order save and ajax request.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v3.0.10
|
|
*
|
|
* @param string $order_id Optional. The order ID. For non-ajax requests, this parameter is required.
|
|
*/
|
|
public static function save_increased_price_lock( $order_id = '' ) {
|
|
|
|
if ( empty( $_POST['woocommerce_meta_nonce'] ) || ! wp_verify_nonce( wc_clean( wp_unslash( $_POST['woocommerce_meta_nonce'] ) ), 'woocommerce_save_data' ) ) {
|
|
return;
|
|
}
|
|
|
|
$order = wc_get_order( wp_doing_ajax() && isset( $_POST['order_id'] ) ? absint( $_POST['order_id'] ) : $order_id );
|
|
|
|
if ( ! $order ) {
|
|
return;
|
|
}
|
|
|
|
if ( isset( $_POST['wcs_order_price_lock'] ) && 'yes' === wc_clean( wp_unslash( $_POST['wcs_order_price_lock'] ) ) ) {
|
|
$order->update_meta_data( '_manual_price_increases_locked', 'true' );
|
|
$order->save();
|
|
} elseif ( $order->meta_exists( '_manual_price_increases_locked' ) ) {
|
|
$order->delete_meta_data( '_manual_price_increases_locked' );
|
|
$order->save();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Stores the subtracted base location tax totals for subscription and renewal line items.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v3.0.10
|
|
*
|
|
* @param int $item_id The ID of the order item added.
|
|
* @param WC_Order_Item_Product $line_item The line item added.
|
|
* @param WC_Abstract_Order $order The order or subscription the product was added to.
|
|
*/
|
|
public static function store_item_base_location_tax( $item_id, $line_item, $order ) {
|
|
if ( ! apply_filters( 'woocommerce_adjust_non_base_location_prices', true ) ) {
|
|
return;
|
|
}
|
|
|
|
if ( ! wc_prices_include_tax() ) {
|
|
return;
|
|
}
|
|
|
|
if ( ! wcs_is_subscription( $order ) && ! wcs_order_contains_renewal( $order ) ) {
|
|
return;
|
|
}
|
|
|
|
if ( '0' !== $line_item->get_tax_class() && 'taxable' === $line_item->get_tax_status() ) {
|
|
$base_tax_rates = WC_Tax::get_base_tax_rates( $line_item->get_tax_class() );
|
|
|
|
/**
|
|
* Find the tax rates that apply to the line item given the current order's address and on what tax calculations are based off.
|
|
*/
|
|
$tax_based_on = get_option( 'woocommerce_tax_based_on' );
|
|
|
|
// If tax calculations are based on the base store location, exit since we know the rates will match.
|
|
if ( 'base' === $tax_based_on ) {
|
|
return;
|
|
}
|
|
|
|
if ( 'shipping' === $tax_based_on && ! $order->get_shipping_country() ) {
|
|
$tax_based_on = 'billing';
|
|
}
|
|
|
|
$applicable_tax_rates = WC_Tax::find_rates(
|
|
array(
|
|
'country' => 'billing' === $tax_based_on ? $order->get_billing_country() : $order->get_shipping_country(),
|
|
'state' => 'billing' === $tax_based_on ? $order->get_billing_state() : $order->get_shipping_state(),
|
|
'postcode' => 'billing' === $tax_based_on ? $order->get_billing_postcode() : $order->get_shipping_postcode(),
|
|
'city' => 'billing' === $tax_based_on ? $order->get_billing_city() : $order->get_shipping_city(),
|
|
'tax_class' => $line_item->get_tax_class(),
|
|
)
|
|
);
|
|
|
|
if ( $applicable_tax_rates === $base_tax_rates ) {
|
|
return;
|
|
}
|
|
|
|
$line_item->update_meta_data( '_subtracted_base_location_taxes', WC_Tax::calc_tax( $line_item->get_product()->get_price(), $base_tax_rates, true ) );
|
|
$line_item->update_meta_data( '_subtracted_base_location_rates', $base_tax_rates );
|
|
$line_item->save();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Prevents WC core's handling of stock for subscriptions saved via the edit subscription screen.
|
|
*
|
|
* Hooked onto 'woocommerce_prevent_adjust_line_item_product_stock' which is triggered in
|
|
* wc_maybe_adjust_line_item_product_stock() via:
|
|
* - WC_AJAX::remove_order_item().
|
|
* - wc_save_order_items().
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v3.1.0
|
|
*
|
|
* @param WC_Order_Item $item The line item being saved/updated via the edit subscription screen.
|
|
* @return bool Whether to reduce stock for the line item.
|
|
*/
|
|
public static function prevent_subscription_line_item_stock_handling( $prevent_stock_handling, $item ) {
|
|
|
|
if ( wcs_is_subscription( $item->get_order_id() ) ) {
|
|
$prevent_stock_handling = true;
|
|
}
|
|
|
|
return $prevent_stock_handling;
|
|
}
|
|
|
|
/**
|
|
* Updates the `_subtracted_base_location_tax` meta when admin users update a line item's quantity.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v3.0.14
|
|
*
|
|
* @param int $order_id The edited order or subscription ID.
|
|
* @param array $item_data An array of data about all line item changes.
|
|
*/
|
|
public static function update_subtracted_base_location_tax_meta( $order_id, $item_data ) {
|
|
|
|
// We're only interested in item quantity changes.
|
|
if ( ! isset( $item_data['order_item_qty'] ) ) {
|
|
return;
|
|
}
|
|
|
|
$is_subscription = wcs_is_subscription( $order_id );
|
|
|
|
// We only need to update subscription and renewal order `_subtracted_base_location_tax` meta data.
|
|
if ( ! $is_subscription && ! wcs_order_contains_renewal( $order_id ) ) {
|
|
return;
|
|
}
|
|
|
|
$object = $is_subscription ? wcs_get_subscription( $order_id ) : wc_get_order( $order_id );
|
|
|
|
if ( ! $object ) {
|
|
return;
|
|
}
|
|
|
|
foreach ( $object->get_items() as $line_item ) {
|
|
// If the line item is tracking the base store location tax amount and the quantity has changed, hook in the function to update that item's meta.
|
|
if ( $line_item->meta_exists( '_subtracted_base_location_tax' ) ) {
|
|
if ( isset( $item_data['order_item_qty'][ $line_item->get_id() ] ) && $item_data['order_item_qty'][ $line_item->get_id() ] !== $line_item->get_quantity() ) {
|
|
$current_base_location_taxes = $line_item->get_meta( '_subtracted_base_location_tax' );
|
|
$previous_quantity = $line_item->get_quantity();
|
|
$new_quantity = $item_data['order_item_qty'][ $line_item->get_id() ];
|
|
$new_base_taxes = array();
|
|
|
|
// Update all the base taxes for the new quantity.
|
|
foreach ( $current_base_location_taxes as $rate_id => $tax_amount ) {
|
|
$new_base_taxes[ $rate_id ] = ( $tax_amount / $previous_quantity ) * $new_quantity;
|
|
}
|
|
|
|
$line_item->update_meta_data( '_subtracted_base_location_tax', $new_base_taxes );
|
|
$line_item->save();
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Updates the `_subtracted_base_location_taxes` meta when admin users update a line item's price.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v3.1.0
|
|
*
|
|
* @param int $order_id The edited order or subscription ID.
|
|
* @param array $item_data An array of data about all line item changes.
|
|
*/
|
|
public static function update_subtracted_base_location_taxes_amount( $order_id, $item_data ) {
|
|
// We're only interested in item subtotal changes.
|
|
if ( ! isset( $item_data['line_subtotal'] ) || ! is_array( $item_data['line_subtotal'] ) ) {
|
|
return;
|
|
}
|
|
|
|
$is_subscription = wcs_is_subscription( $order_id );
|
|
|
|
// We only need to update subscription and renewal order `_subtracted_base_location_taxes` meta data.
|
|
if ( ! $is_subscription && ! wcs_order_contains_renewal( $order_id ) ) {
|
|
return;
|
|
}
|
|
|
|
$object = $is_subscription ? wcs_get_subscription( $order_id ) : wc_get_order( $order_id );
|
|
|
|
if ( ! $object ) {
|
|
return;
|
|
}
|
|
|
|
foreach ( $item_data['line_subtotal'] as $line_item_id => $new_line_subtotal ) {
|
|
$line_item = WC_Order_Factory::get_order_item( $line_item_id );
|
|
|
|
if ( ! $line_item ) {
|
|
continue;
|
|
}
|
|
|
|
// If this item's subtracted tax data hasn't been repaired, do that now.
|
|
if ( $line_item->meta_exists( '_subtracted_base_location_tax' ) ) {
|
|
WC_Subscriptions_Upgrader::repair_subtracted_base_taxes( $line_item->get_id() );
|
|
$line_item = WC_Order_Factory::get_order_item( $line_item->get_id() );
|
|
}
|
|
|
|
if ( ! $line_item->meta_exists( '_subtracted_base_location_taxes' ) ) {
|
|
continue;
|
|
}
|
|
|
|
$new_line_subtotal = wc_format_decimal( $new_line_subtotal );
|
|
$current_base_location_taxes = $line_item->get_meta( '_subtracted_base_location_taxes' );
|
|
$old_line_subtotal = $line_item->get_subtotal();
|
|
$old_line_quantity = $line_item->get_quantity();
|
|
$new_line_quantity = absint( $item_data['order_item_qty'][ $line_item_id ] );
|
|
|
|
if ( $line_item->meta_exists( '_subtracted_base_location_rates' ) ) {
|
|
$base_tax_rates = $line_item->get_meta( '_subtracted_base_location_rates' );
|
|
$product_price = ( $new_line_subtotal + array_sum( WC_Tax::calc_exclusive_tax( $new_line_subtotal, $base_tax_rates ) ) ) / $new_line_quantity;
|
|
|
|
$new_base_taxes = WC_Tax::calc_tax( $product_price, $base_tax_rates, true );
|
|
} else {
|
|
// Update all the base taxes for the new product subtotal.
|
|
foreach ( $current_base_location_taxes as $rate_id => $tax_amount ) {
|
|
$new_base_taxes[ $rate_id ] = ( ( $new_line_subtotal / $new_line_quantity ) / ( $old_line_subtotal / $old_line_quantity ) ) * $tax_amount;
|
|
}
|
|
}
|
|
|
|
$line_item->update_meta_data( '_subtracted_base_location_taxes', $new_base_taxes );
|
|
$line_item->save();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Gets a list of customer orders via ajax.
|
|
*
|
|
* Populates the parent order list on the edit subscription screen with orders belonging to the customer.
|
|
*
|
|
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v4.0.0
|
|
*/
|
|
public static function get_customer_orders() {
|
|
check_ajax_referer( 'get-customer-orders', 'security' );
|
|
|
|
if ( ! current_user_can( 'edit_shop_orders' ) ) {
|
|
wp_die( -1 );
|
|
}
|
|
|
|
$customer_orders = array();
|
|
$user_id = absint( $_POST['user_id'] ?? null );
|
|
$orders = wc_get_orders(
|
|
array(
|
|
'customer' => $user_id,
|
|
'post_type' => 'shop_order',
|
|
'posts_per_page' => '-1',
|
|
)
|
|
);
|
|
|
|
foreach ( $orders as $order ) {
|
|
$customer_orders[ $order->get_id() ] = $order->get_order_number();
|
|
}
|
|
|
|
wp_send_json( $customer_orders );
|
|
}
|
|
|
|
/**
|
|
* Reorders the edit subscription screen meta boxes.
|
|
*
|
|
* Removes and readds the order items meta box so it appears after the subscription data.
|
|
*
|
|
* On HPOS environments, WC core registers the order-data and order-items meta boxes on a high priority before we've had a chance to add ours.
|
|
* This means, on the edit subscription screen, when we remove the order-data meta box and add our own, it will appear after the line items.
|
|
*
|
|
* In order to keep the correct ordering of the meta boxes on the edit subscription screen, we need to remove the line items meta box and
|
|
* readd it after we've added the subscription-data meta box.
|
|
*/
|
|
private static function reorder_subscription_line_items_meta_box() {
|
|
global $wp_meta_boxes;
|
|
$subscriptions_screen_id = wcs_get_page_screen_id( 'shop_subscription' );
|
|
|
|
// If the line items meta box isn't registered, bail.
|
|
if ( empty( $wp_meta_boxes[ $subscriptions_screen_id ]['normal']['high']['woocommerce-order-items'] ) ) {
|
|
return;
|
|
}
|
|
|
|
// Get a copy of the line items meta box.
|
|
$items_meta_box = $wp_meta_boxes[ $subscriptions_screen_id ]['normal']['high']['woocommerce-order-items'];
|
|
|
|
// Forcibly remove the line items meta box to reset its ordering in the list.
|
|
unset( $wp_meta_boxes[ $subscriptions_screen_id ]['normal']['high']['woocommerce-order-items'] );
|
|
|
|
// Readd it.
|
|
add_meta_box(
|
|
$items_meta_box['id'],
|
|
$items_meta_box['title'],
|
|
$items_meta_box['callback'],
|
|
$subscriptions_screen_id,
|
|
'normal',
|
|
'high',
|
|
$items_meta_box['args']
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Notifies the user of an operational success or failure, and records a matching order note.
|
|
*
|
|
* In essence, it can be convenient to generate both an admin notice (to give the user some clear and
|
|
* obvious feedback) and record the same as an order note (the admin notice could be missed, and is
|
|
* auto-dismissed after the first view).
|
|
*
|
|
* @param WC_Subscription $subscription The subscription we are working with.
|
|
* @param string $type Message type: 'success' or 'error.
|
|
* @param string $message Message text, which will be used both for an admin notice and for the order note.
|
|
*
|
|
* @return void
|
|
*/
|
|
private static function notify( WC_Subscription $subscription, $type, $message ) {
|
|
$subscription->add_order_note( $message, false, true );
|
|
wcs_add_admin_notice( $message, $type );
|
|
}
|
|
}
|