WC_Deprecated_Action_Hooks{} │ WC 1.0
Handles deprecation notices and triggering of legacy action hooks.
Hooks from the class
Usage
$WC_Deprecated_Action_Hooks = new WC_Deprecated_Action_Hooks(); // use class methods
Methods
- public handle_deprecated_hook( $new_hook, $old_hook, $new_callback_args, $return_value )
- public hook_in( $hook_name )
- protected trigger_hook( $old_hook, $new_callback_args )
WC_Deprecated_Action_Hooks{} WC Deprecated Action Hooks{} code WC 8.7.0
class WC_Deprecated_Action_Hooks extends WC_Deprecated_Hooks {
/**
* Array of deprecated hooks we need to handle. Format of 'new' => 'old'.
*
* @var array
*/
protected $deprecated_hooks = array(
'woocommerce_new_order_item' => array(
'woocommerce_order_add_shipping',
'woocommerce_order_add_coupon',
'woocommerce_order_add_tax',
'woocommerce_order_add_fee',
'woocommerce_add_shipping_order_item',
'woocommerce_add_order_item_meta',
'woocommerce_add_order_fee_meta',
),
'woocommerce_update_order_item' => array(
'woocommerce_order_edit_product',
'woocommerce_order_update_coupon',
'woocommerce_order_update_shipping',
'woocommerce_order_update_fee',
'woocommerce_order_update_tax',
),
'woocommerce_new_payment_token' => 'woocommerce_payment_token_created',
'woocommerce_new_product_variation' => 'woocommerce_create_product_variation',
'woocommerce_order_details_after_order_table_items' => 'woocommerce_order_items_table',
'woocommerce_settings_advanced_page_options' => array(
'woocommerce_settings_checkout_page_options',
'woocommerce_settings_account_page_options',
),
'woocommerce_settings_advanced_page_options_end' => array(
'woocommerce_settings_checkout_page_options_end',
'woocommerce_settings_account_page_options_end',
),
'woocommerce_settings_advanced_page_options_after' => array(
'woocommerce_settings_checkout_page_options_after',
'woocommerce_settings_account_page_options_after',
),
);
/**
* Array of versions on each hook has been deprecated.
*
* @var array
*/
protected $deprecated_version = array(
'woocommerce_order_add_shipping' => '3.0.0',
'woocommerce_order_add_coupon' => '3.0.0',
'woocommerce_order_add_tax' => '3.0.0',
'woocommerce_order_add_fee' => '3.0.0',
'woocommerce_add_shipping_order_item' => '3.0.0',
'woocommerce_add_order_item_meta' => '3.0.0',
'woocommerce_add_order_fee_meta' => '3.0.0',
'woocommerce_order_edit_product' => '3.0.0',
'woocommerce_order_update_coupon' => '3.0.0',
'woocommerce_order_update_shipping' => '3.0.0',
'woocommerce_order_update_fee' => '3.0.0',
'woocommerce_order_update_tax' => '3.0.0',
'woocommerce_payment_token_created' => '3.0.0',
'woocommerce_create_product_variation' => '3.0.0',
'woocommerce_order_items_table' => '3.0.0',
'woocommerce_settings_checkout_page_options' => '3.4.0',
'woocommerce_settings_account_page_options' => '3.4.0',
'woocommerce_settings_checkout_page_options_end' => '3.4.0',
'woocommerce_settings_account_page_options_end' => '3.4.0',
'woocommerce_settings_checkout_page_options_after' => '3.4.0',
'woocommerce_settings_account_page_options_after' => '3.4.0',
);
/**
* Hook into the new hook so we can handle deprecated hooks once fired.
*
* @param string $hook_name Hook name.
*/
public function hook_in( $hook_name ) {
add_action( $hook_name, array( $this, 'maybe_handle_deprecated_hook' ), -1000, 8 );
}
/**
* If the old hook is in-use, trigger it.
*
* @param string $new_hook New hook name.
* @param string $old_hook Old hook name.
* @param array $new_callback_args New callback args.
* @param mixed $return_value Returned value.
* @return mixed
*/
public function handle_deprecated_hook( $new_hook, $old_hook, $new_callback_args, $return_value ) {
if ( has_action( $old_hook ) ) {
$this->display_notice( $old_hook, $new_hook );
$return_value = $this->trigger_hook( $old_hook, $new_callback_args );
}
return $return_value;
}
/**
* Fire off a legacy hook with it's args.
*
* @param string $old_hook Old hook name.
* @param array $new_callback_args New callback args.
* @return mixed
*/
protected function trigger_hook( $old_hook, $new_callback_args ) {
switch ( $old_hook ) {
case 'woocommerce_order_add_shipping':
case 'woocommerce_order_add_fee':
$item_id = $new_callback_args[0];
$item = $new_callback_args[1];
$order_id = $new_callback_args[2];
if ( is_a( $item, 'WC_Order_Item_Shipping' ) || is_a( $item, 'WC_Order_Item_Fee' ) ) {
do_action( $old_hook, $order_id, $item_id, $item );
}
break;
case 'woocommerce_order_add_coupon':
$item_id = $new_callback_args[0];
$item = $new_callback_args[1];
$order_id = $new_callback_args[2];
if ( is_a( $item, 'WC_Order_Item_Coupon' ) ) {
do_action( $old_hook, $order_id, $item_id, $item->get_code(), $item->get_discount(), $item->get_discount_tax() );
}
break;
case 'woocommerce_order_add_tax':
$item_id = $new_callback_args[0];
$item = $new_callback_args[1];
$order_id = $new_callback_args[2];
if ( is_a( $item, 'WC_Order_Item_Tax' ) ) {
do_action( $old_hook, $order_id, $item_id, $item->get_rate_id(), $item->get_tax_total(), $item->get_shipping_tax_total() );
}
break;
case 'woocommerce_add_shipping_order_item':
$item_id = $new_callback_args[0];
$item = $new_callback_args[1];
$order_id = $new_callback_args[2];
if ( is_a( $item, 'WC_Order_Item_Shipping' ) ) {
do_action( $old_hook, $order_id, $item_id, $item->legacy_package_key );
}
break;
case 'woocommerce_add_order_item_meta':
$item_id = $new_callback_args[0];
$item = $new_callback_args[1];
$order_id = $new_callback_args[2];
if ( is_a( $item, 'WC_Order_Item_Product' ) ) {
do_action( $old_hook, $item_id, $item->legacy_values, $item->legacy_cart_item_key );
}
break;
case 'woocommerce_add_order_fee_meta':
$item_id = $new_callback_args[0];
$item = $new_callback_args[1];
$order_id = $new_callback_args[2];
if ( is_a( $item, 'WC_Order_Item_Fee' ) ) {
do_action( $old_hook, $order_id, $item_id, $item->legacy_fee, $item->legacy_fee_key );
}
break;
case 'woocommerce_order_edit_product':
$item_id = $new_callback_args[0];
$item = $new_callback_args[1];
$order_id = $new_callback_args[2];
if ( is_a( $item, 'WC_Order_Item_Product' ) ) {
do_action( $old_hook, $order_id, $item_id, $item, $item->get_product() );
}
break;
default:
do_action_ref_array( $old_hook, $new_callback_args );
break;
}
}
}