class-wc-deprecated-action-hooks.php — WooCommerce 3.0.1

woocommerce / includes / class-wc-deprecated-action-hooks.php

woocommerce / includes Last commit date

class-wc-deprecated-action-hooks.php

144 lines

1	<?php
2	if ( ! defined( 'ABSPATH' ) ) {
3	exit;
4	}
5
6	/**
7	* Handles deprecation notices and triggering of legacy action hooks.
8	*
9	* @since 3.0.0
10	*/
11	class WC_Deprecated_Action_Hooks extends WC_Deprecated_Hooks {
12
13	/**
14	* Array of deprecated hooks we need to handle.
15	*
16	* @var array
17	*/
18	protected $deprecated_hooks = array(
19	'woocommerce_new_order_item' => array(
20	'woocommerce_order_add_shipping',
21	'woocommerce_order_add_coupon',
22	'woocommerce_order_add_tax',
23	'woocommerce_order_add_fee',
24	'woocommerce_add_shipping_order_item',
25	'woocommerce_add_order_item_meta',
26	'woocommerce_add_order_fee_meta',
27	),
28	'woocommerce_update_order_item' => array(
29	'woocommerce_order_edit_product',
30	'woocommerce_order_update_coupon',
31	'woocommerce_order_update_shipping',
32	'woocommerce_order_update_fee',
33	'woocommerce_order_update_tax',
34	),
35	'woocommerce_new_payment_token' => 'woocommerce_payment_token_created',
36	'woocommerce_new_product_variation' => 'woocommerce_create_product_variation',
37	);
38
39	/**
40	* Hook into the new hook so we can handle deprecated hooks once fired.
41	* @param string $hook_name
42	*/
43	public function hook_in( $hook_name ) {
44	add_action( $hook_name, array( $this, 'maybe_handle_deprecated_hook' ), -1000, 8 );
45	}
46
47	/**
48	* If the old hook is in-use, trigger it.
49	*
50	* @param string $new_hook
51	* @param string $old_hook
52	* @param array $new_callback_args
53	* @param mixed $return_value
54	* @return mixed
55	*/
56	public function handle_deprecated_hook( $new_hook, $old_hook, $new_callback_args, $return_value ) {
57	if ( has_action( $old_hook ) ) {
58	$this->display_notice( $old_hook, $new_hook );
59	$return_value = $this->trigger_hook( $old_hook, $new_callback_args );
60	}
61	return $return_value;
62	}
63
64	/**
65	* Fire off a legacy hook with it's args.
66	*
67	* @param string $old_hook
68	* @param array $new_callback_args
69	* @return mixed
70	*/
71	protected function trigger_hook( $old_hook, $new_callback_args ) {
72	switch ( $old_hook ) {
73	case 'woocommerce_order_add_shipping' :
74	case 'woocommerce_order_add_fee' :
75	$item_id = $new_callback_args[0];
76	$item = $new_callback_args[1];
77	$order_id = $new_callback_args[2];
78	if ( is_a( $item, 'WC_Order_Item_Shipping' ) \|\| is_a( $item, 'WC_Order_Item_Fee' ) ) {
79	do_action( $old_hook, $order_id, $item_id, $item );
80	}
81	break;
82	case 'woocommerce_order_add_coupon' :
83	$item_id = $new_callback_args[0];
84	$item = $new_callback_args[1];
85	$order_id = $new_callback_args[2];
86	if ( is_a( $item, 'WC_Order_Item_Coupon' ) ) {
87	do_action( $old_hook, $order_id, $item_id, $item->get_code(), $item->get_discount(), $item->get_discount_tax() );
88	}
89	break;
90	case 'woocommerce_order_add_tax' :
91	$item_id = $new_callback_args[0];
92	$item = $new_callback_args[1];
93	$order_id = $new_callback_args[2];
94	if ( is_a( $item, 'WC_Order_Item_Tax' ) ) {
95	do_action( $old_hook, $order_id, $item_id, $item->get_rate_id(), $item->get_tax_total(), $item->get_shipping_tax_total() );
96	}
97	break;
98	case 'woocommerce_add_shipping_order_item' :
99	$item_id = $new_callback_args[0];
100	$item = $new_callback_args[1];
101	$order_id = $new_callback_args[2];
102	if ( is_a( $item, 'WC_Order_Item_Shipping' ) ) {
103	do_action( $old_hook, $order_id, $item_id, $item->legacy_package_key );
104	}
105	break;
106	case 'woocommerce_add_order_item_meta' :
107	$item_id = $new_callback_args[0];
108	$item = $new_callback_args[1];
109	$order_id = $new_callback_args[2];
110	if ( is_a( $item, 'WC_Order_Item_Product' ) ) {
111	do_action( $old_hook, $item_id, $item->legacy_values, $item->legacy_cart_item_key );
112	}
113	break;
114	case 'woocommerce_add_order_fee_meta' :
115	$item_id = $new_callback_args[0];
116	$item = $new_callback_args[1];
117	$order_id = $new_callback_args[2];
118	if ( is_a( $item, 'WC_Order_Item_Fee' ) ) {
119	do_action( $old_hook, $order_id, $item_id, $item->legacy_fee, $item->legacy_fee_key );
120	}
121	break;
122	case 'woocommerce_order_edit_product' :
123	$item_id = $new_callback_args[0];
124	$item = $new_callback_args[1];
125	$order_id = $new_callback_args[2];
126	if ( is_a( $item, 'WC_Order_Item_Product' ) ) {
127	do_action( $old_hook, $order_id, $item_id, $item, $item->get_product() );
128	}
129	break;
130	case 'woocommerce_order_update_coupon' :
131	case 'woocommerce_order_update_shipping' :
132	case 'woocommerce_order_update_fee' :
133	case 'woocommerce_order_update_tax' :
134	if ( ! is_a( $item, 'WC_Order_Item_Product' ) ) {
135	do_action( $old_hook, $order_id, $item_id, $item );
136	}
137	break;
138	default :
139	do_action_ref_array( $old_hook, $new_callback_args );
140	break;
141	}
142	}
143	}
144