class-wc-deprecated-filter-hooks.php — WooCommerce 10.2.3

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

woocommerce / includes Last commit date

class-wc-deprecated-filter-hooks.php

149 lines

1	<?php
2	/**
3	* Deprecated filter hooks
4	*
5	* @package WooCommerce\Abstracts
6	* @since 3.0.0
7	* @version 3.3.0
8	*/
9
10	defined( 'ABSPATH' ) \|\| exit;
11
12	/**
13	* Handles deprecation notices and triggering of legacy filter hooks
14	*/
15	class WC_Deprecated_Filter_Hooks extends WC_Deprecated_Hooks {
16
17	/**
18	* Array of deprecated hooks we need to handle.
19	* Format of 'new' => 'old'.
20	*
21	* @var array
22	*/
23	protected $deprecated_hooks = array(
24	'woocommerce_account_orders_columns' => 'woocommerce_my_account_my_orders_columns',
25	'woocommerce_structured_data_order' => 'woocommerce_email_order_schema_markup',
26	'woocommerce_add_to_cart_fragments' => 'add_to_cart_fragments',
27	'woocommerce_add_to_cart_redirect' => 'add_to_cart_redirect',
28	'woocommerce_product_get_width' => 'woocommerce_product_width',
29	'woocommerce_product_get_height' => 'woocommerce_product_height',
30	'woocommerce_product_get_length' => 'woocommerce_product_length',
31	'woocommerce_product_get_weight' => 'woocommerce_product_weight',
32	'woocommerce_product_get_sku' => 'woocommerce_get_sku',
33	'woocommerce_product_get_price' => 'woocommerce_get_price',
34	'woocommerce_product_get_regular_price' => 'woocommerce_get_regular_price',
35	'woocommerce_product_get_sale_price' => 'woocommerce_get_sale_price',
36	'woocommerce_product_get_tax_class' => 'woocommerce_product_tax_class',
37	'woocommerce_product_get_stock_quantity' => 'woocommerce_get_stock_quantity',
38	'woocommerce_product_get_attributes' => 'woocommerce_get_product_attributes',
39	'woocommerce_product_get_gallery_image_ids' => 'woocommerce_product_gallery_attachment_ids',
40	'woocommerce_product_get_review_count' => 'woocommerce_product_review_count',
41	'woocommerce_product_get_downloads' => 'woocommerce_product_files',
42	'woocommerce_order_get_currency' => 'woocommerce_get_currency',
43	'woocommerce_order_get_discount_total' => 'woocommerce_order_amount_discount_total',
44	'woocommerce_order_get_discount_tax' => 'woocommerce_order_amount_discount_tax',
45	'woocommerce_order_get_shipping_total' => 'woocommerce_order_amount_shipping_total',
46	'woocommerce_order_get_shipping_tax' => 'woocommerce_order_amount_shipping_tax',
47	'woocommerce_order_get_cart_tax' => 'woocommerce_order_amount_cart_tax',
48	'woocommerce_order_get_total' => 'woocommerce_order_amount_total',
49	'woocommerce_order_get_total_tax' => 'woocommerce_order_amount_total_tax',
50	'woocommerce_order_get_total_discount' => 'woocommerce_order_amount_total_discount',
51	'woocommerce_order_get_subtotal' => 'woocommerce_order_amount_subtotal',
52	'woocommerce_order_get_tax_totals' => 'woocommerce_order_tax_totals',
53	'woocommerce_get_order_refund_get_amount' => 'woocommerce_refund_amount',
54	'woocommerce_get_order_refund_get_reason' => 'woocommerce_refund_reason',
55	'default_checkout_billing_country' => 'default_checkout_country',
56	'default_checkout_billing_state' => 'default_checkout_state',
57	'default_checkout_billing_postcode' => 'default_checkout_postcode',
58	'woocommerce_system_status_environment_rows' => 'woocommerce_debug_posting',
59	'woocommerce_credit_card_type_labels' => 'wocommerce_credit_card_type_labels',
60	'woocommerce_settings_tabs_advanced' => 'woocommerce_settings_tabs_api',
61	'woocommerce_settings_advanced' => 'woocommerce_settings_api',
62	'woocommerce_csv_importer_check_import_file_path' => 'woocommerce_product_csv_importer_check_import_file_path',
63	);
64
65	/**
66	* Array of versions on each hook has been deprecated.
67	*
68	* @var array
69	*/
70	protected $deprecated_version = array(
71	'woocommerce_my_account_my_orders_columns' => '2.6.0',
72	'woocommerce_email_order_schema_markup' => '3.0.0',
73	'add_to_cart_fragments' => '3.0.0',
74	'add_to_cart_redirect' => '3.0.0',
75	'woocommerce_product_width' => '3.0.0',
76	'woocommerce_product_height' => '3.0.0',
77	'woocommerce_product_length' => '3.0.0',
78	'woocommerce_product_weight' => '3.0.0',
79	'woocommerce_get_sku' => '3.0.0',
80	'woocommerce_get_price' => '3.0.0',
81	'woocommerce_get_regular_price' => '3.0.0',
82	'woocommerce_get_sale_price' => '3.0.0',
83	'woocommerce_product_tax_class' => '3.0.0',
84	'woocommerce_get_stock_quantity' => '3.0.0',
85	'woocommerce_get_product_attributes' => '3.0.0',
86	'woocommerce_product_gallery_attachment_ids' => '3.0.0',
87	'woocommerce_product_review_count' => '3.0.0',
88	'woocommerce_product_files' => '3.0.0',
89	'woocommerce_get_currency' => '3.0.0',
90	'woocommerce_order_amount_discount_total' => '3.0.0',
91	'woocommerce_order_amount_discount_tax' => '3.0.0',
92	'woocommerce_order_amount_shipping_total' => '3.0.0',
93	'woocommerce_order_amount_shipping_tax' => '3.0.0',
94	'woocommerce_order_amount_cart_tax' => '3.0.0',
95	'woocommerce_order_amount_total' => '3.0.0',
96	'woocommerce_order_amount_total_tax' => '3.0.0',
97	'woocommerce_order_amount_total_discount' => '3.0.0',
98	'woocommerce_order_amount_subtotal' => '3.0.0',
99	'woocommerce_order_tax_totals' => '3.0.0',
100	'woocommerce_refund_amount' => '3.0.0',
101	'woocommerce_refund_reason' => '3.0.0',
102	'default_checkout_country' => '3.0.0',
103	'default_checkout_state' => '3.0.0',
104	'default_checkout_postcode' => '3.0.0',
105	'woocommerce_debug_posting' => '3.0.0',
106	'wocommerce_credit_card_type_labels' => '3.0.0',
107	'woocommerce_settings_tabs_api' => '3.4.0',
108	'woocommerce_settings_api' => '3.4.0',
109	'woocommerce_product_csv_importer_check_import_file_path' => '6.5.0',
110	);
111
112	/**
113	* Hook into the new hook so we can handle deprecated hooks once fired.
114	*
115	* @param string $hook_name Hook name.
116	*/
117	public function hook_in( $hook_name ) {
118	add_filter( $hook_name, array( $this, 'maybe_handle_deprecated_hook' ), -1000, 8 );
119	}
120
121	/**
122	* If the old hook is in-use, trigger it.
123	*
124	* @param string $new_hook New hook name.
125	* @param string $old_hook Old hook name.
126	* @param array $new_callback_args New callback args.
127	* @param mixed $return_value Returned value.
128	* @return mixed
129	*/
130	public function handle_deprecated_hook( $new_hook, $old_hook, $new_callback_args, $return_value ) {
131	if ( has_filter( $old_hook ) ) {
132	$this->display_notice( $old_hook, $new_hook );
133	$return_value = $this->trigger_hook( $old_hook, $new_callback_args );
134	}
135	return $return_value;
136	}
137
138	/**
139	* Fire off a legacy hook with it's args.
140	*
141	* @param string $old_hook Old hook name.
142	* @param array $new_callback_args New callback args.
143	* @return mixed
144	*/
145	protected function trigger_hook( $old_hook, $new_callback_args ) {
146	return apply_filters_ref_array( $old_hook, $new_callback_args );
147	}
148	}
149