wc-template-hooks.php — WooCommerce 10.2.3

woocommerce / includes / wc-template-hooks.php

woocommerce / includes Last commit date

wc-template-hooks.php

336 lines

1	<?php
2	/**
3	* WooCommerce Template Hooks
4	*
5	* Action/filter hooks used for WooCommerce functions/templates.
6	*
7	* @package WooCommerce\Templates
8	* @version 2.1.0
9	*/
10
11	defined( 'ABSPATH' ) \|\| exit;
12
13	add_filter( 'body_class', 'wc_body_class' );
14	add_filter( 'post_class', 'wc_product_post_class', 20, 3 );
15
16	/**
17	* WP Header.
18	*
19	* @see wc_generator_tag()
20	*/
21	add_filter( 'get_the_generator_html', 'wc_generator_tag', 10, 2 );
22	add_filter( 'get_the_generator_xhtml', 'wc_generator_tag', 10, 2 );
23
24	/**
25	* Content Wrappers.
26	*
27	* @see woocommerce_output_content_wrapper()
28	* @see woocommerce_output_content_wrapper_end()
29	*/
30	add_action( 'woocommerce_before_main_content', 'woocommerce_output_content_wrapper', 10 );
31	add_action( 'woocommerce_after_main_content', 'woocommerce_output_content_wrapper_end', 10 );
32
33	/**
34	* Sale flashes.
35	*
36	* @see woocommerce_show_product_loop_sale_flash()
37	* @see woocommerce_show_product_sale_flash()
38	*/
39	add_action( 'woocommerce_before_shop_loop_item_title', 'woocommerce_show_product_loop_sale_flash', 10 );
40	add_action( 'woocommerce_before_single_product_summary', 'woocommerce_show_product_sale_flash', 10 );
41
42	/**
43	* Breadcrumbs.
44	*
45	* @see woocommerce_breadcrumb()
46	*/
47	add_action( 'woocommerce_before_main_content', 'woocommerce_breadcrumb', 20, 0 );
48
49	/**
50	* Sidebar.
51	*
52	* @see woocommerce_get_sidebar()
53	*/
54	add_action( 'woocommerce_sidebar', 'woocommerce_get_sidebar', 10 );
55
56	/**
57	* Archive header.
58	*
59	* @see woocommerce_product_taxonomy_archive_header()
60	*/
61	add_action( 'woocommerce_shop_loop_header', 'woocommerce_product_taxonomy_archive_header' );
62
63	/**
64	* Archive descriptions.
65	*
66	* @see woocommerce_taxonomy_archive_description()
67	* @see woocommerce_product_archive_description()
68	*/
69	add_action( 'woocommerce_archive_description', 'woocommerce_taxonomy_archive_description', 10 );
70	add_action( 'woocommerce_archive_description', 'woocommerce_product_archive_description', 10 );
71
72	/**
73	* Product loop start.
74	*/
75	add_filter( 'woocommerce_product_loop_start', 'woocommerce_maybe_show_product_subcategories' );
76
77	/**
78	* Products Loop.
79	*
80	* @see woocommerce_result_count()
81	* @see woocommerce_catalog_ordering()
82	*/
83	add_action( 'woocommerce_before_shop_loop', 'woocommerce_result_count', 20 );
84	add_action( 'woocommerce_before_shop_loop', 'woocommerce_catalog_ordering', 30 );
85	add_action( 'woocommerce_no_products_found', 'wc_no_products_found' );
86
87	/**
88	* Product Loop Items.
89	*
90	* @see woocommerce_template_loop_product_link_open()
91	* @see woocommerce_template_loop_product_link_close()
92	* @see woocommerce_template_loop_add_to_cart()
93	* @see woocommerce_template_loop_product_thumbnail()
94	* @see woocommerce_template_loop_product_title()
95	* @see woocommerce_template_loop_category_link_open()
96	* @see woocommerce_template_loop_category_title()
97	* @see woocommerce_template_loop_category_link_close()
98	* @see woocommerce_template_loop_price()
99	* @see woocommerce_template_loop_rating()
100	*/
101	add_action( 'woocommerce_before_shop_loop_item', 'woocommerce_template_loop_product_link_open', 10 );
102	add_action( 'woocommerce_after_shop_loop_item', 'woocommerce_template_loop_product_link_close', 5 );
103	add_action( 'woocommerce_after_shop_loop_item', 'woocommerce_template_loop_add_to_cart', 10 );
104	add_action( 'woocommerce_before_shop_loop_item_title', 'woocommerce_template_loop_product_thumbnail', 10 );
105	add_action( 'woocommerce_shop_loop_item_title', 'woocommerce_template_loop_product_title', 10 );
106
107	add_action( 'woocommerce_before_subcategory', 'woocommerce_template_loop_category_link_open', 10 );
108	add_action( 'woocommerce_shop_loop_subcategory_title', 'woocommerce_template_loop_category_title', 10 );
109	add_action( 'woocommerce_after_subcategory', 'woocommerce_template_loop_category_link_close', 10 );
110
111	add_action( 'woocommerce_after_shop_loop_item_title', 'woocommerce_template_loop_price', 10 );
112	add_action( 'woocommerce_after_shop_loop_item_title', 'woocommerce_template_loop_rating', 5 );
113
114	/**
115	* Subcategories.
116	*
117	* @see woocommerce_subcategory_thumbnail()
118	*/
119	add_action( 'woocommerce_before_subcategory_title', 'woocommerce_subcategory_thumbnail', 10 );
120
121	/**
122	* Before Single Products Summary Div.
123	*
124	* @see woocommerce_show_product_images()
125	* @see woocommerce_show_product_thumbnails()
126	*/
127	add_action( 'woocommerce_before_single_product_summary', 'woocommerce_show_product_images', 20 );
128	add_action( 'woocommerce_product_thumbnails', 'woocommerce_show_product_thumbnails', 20 );
129
130	/**
131	* After Single Products Summary Div.
132	*
133	* @see woocommerce_output_product_data_tabs()
134	* @see woocommerce_upsell_display()
135	* @see woocommerce_output_related_products()
136	*/
137	add_action( 'woocommerce_after_single_product_summary', 'woocommerce_output_product_data_tabs', 10 );
138	add_action( 'woocommerce_after_single_product_summary', 'woocommerce_upsell_display', 15 );
139	add_action( 'woocommerce_after_single_product_summary', 'woocommerce_output_related_products', 20 );
140
141	/**
142	* Product Summary Box.
143	*
144	* @see woocommerce_template_single_title()
145	* @see woocommerce_template_single_rating()
146	* @see woocommerce_template_single_price()
147	* @see woocommerce_template_single_excerpt()
148	* @see woocommerce_template_single_meta()
149	* @see woocommerce_template_single_sharing()
150	*/
151	add_action( 'woocommerce_single_product_summary', 'woocommerce_template_single_title', 5 );
152	add_action( 'woocommerce_single_product_summary', 'woocommerce_template_single_rating', 10 );
153	add_action( 'woocommerce_single_product_summary', 'woocommerce_template_single_price', 10 );
154	add_action( 'woocommerce_single_product_summary', 'woocommerce_template_single_excerpt', 20 );
155	add_action( 'woocommerce_single_product_summary', 'woocommerce_template_single_meta', 40 );
156	add_action( 'woocommerce_single_product_summary', 'woocommerce_template_single_sharing', 50 );
157
158	/**
159	* Reviews
160	*
161	* @see woocommerce_review_display_gravatar()
162	* @see woocommerce_review_display_rating()
163	* @see woocommerce_review_display_meta()
164	* @see woocommerce_review_display_comment_text()
165	*/
166	add_action( 'woocommerce_review_before', 'woocommerce_review_display_gravatar', 10 );
167	add_action( 'woocommerce_review_before_comment_meta', 'woocommerce_review_display_rating', 10 );
168	add_action( 'woocommerce_review_meta', 'woocommerce_review_display_meta', 10 );
169	add_action( 'woocommerce_review_comment_text', 'woocommerce_review_display_comment_text', 10 );
170
171	/**
172	* Product Add to cart.
173	*
174	* @see woocommerce_template_single_add_to_cart()
175	* @see woocommerce_simple_add_to_cart()
176	* @see woocommerce_grouped_add_to_cart()
177	* @see woocommerce_variable_add_to_cart()
178	* @see woocommerce_external_add_to_cart()
179	* @see woocommerce_single_variation()
180	* @see woocommerce_single_variation_add_to_cart_button()
181	*/
182	add_action( 'woocommerce_single_product_summary', 'woocommerce_template_single_add_to_cart', 30 );
183	add_action( 'woocommerce_simple_add_to_cart', 'woocommerce_simple_add_to_cart', 30 );
184	add_action( 'woocommerce_grouped_add_to_cart', 'woocommerce_grouped_add_to_cart', 30 );
185	add_action( 'woocommerce_variable_add_to_cart', 'woocommerce_variable_add_to_cart', 30 );
186	add_action( 'woocommerce_external_add_to_cart', 'woocommerce_external_add_to_cart', 30 );
187	add_action( 'woocommerce_single_variation', 'woocommerce_single_variation', 10 );
188	add_action( 'woocommerce_single_variation', 'woocommerce_single_variation_add_to_cart_button', 20 );
189
190	/**
191	* Pagination after shop loops.
192	*
193	* @see woocommerce_pagination()
194	*/
195	add_action( 'woocommerce_after_shop_loop', 'woocommerce_pagination', 10 );
196
197	/**
198	* Product page tabs.
199	*/
200	add_filter( 'woocommerce_product_tabs', 'woocommerce_default_product_tabs' );
201	add_filter( 'woocommerce_product_tabs', 'woocommerce_sort_product_tabs', 99 );
202
203	/**
204	* Additional Information tab.
205	*
206	* @see wc_display_product_attributes()
207	*/
208	add_action( 'woocommerce_product_additional_information', 'wc_display_product_attributes', 10 );
209
210	/**
211	* Checkout.
212	*
213	* @see woocommerce_checkout_login_form()
214	* @see woocommerce_checkout_coupon_form()
215	* @see woocommerce_order_review()
216	* @see woocommerce_checkout_payment()
217	* @see wc_checkout_privacy_policy_text()
218	* @see wc_terms_and_conditions_page_content()
219	* @see wc_get_pay_buttons()
220	*/
221	add_action( 'woocommerce_before_checkout_form', 'woocommerce_checkout_login_form', 10 );
222	add_action( 'woocommerce_before_checkout_form', 'woocommerce_checkout_coupon_form', 10 );
223	add_action( 'woocommerce_checkout_order_review', 'woocommerce_order_review', 10 );
224	add_action( 'woocommerce_checkout_order_review', 'woocommerce_checkout_payment', 20 );
225	add_action( 'woocommerce_checkout_terms_and_conditions', 'wc_checkout_privacy_policy_text', 20 );
226	add_action( 'woocommerce_checkout_terms_and_conditions', 'wc_terms_and_conditions_page_content', 30 );
227	add_action( 'woocommerce_checkout_before_customer_details', 'wc_get_pay_buttons', 30 );
228
229	/**
230	* Cart widget
231	*/
232	add_action( 'woocommerce_widget_shopping_cart_buttons', 'woocommerce_widget_shopping_cart_button_view_cart', 10 );
233	add_action( 'woocommerce_widget_shopping_cart_buttons', 'woocommerce_widget_shopping_cart_proceed_to_checkout', 20 );
234	add_action( 'woocommerce_widget_shopping_cart_total', 'woocommerce_widget_shopping_cart_subtotal', 10 );
235
236	/**
237	* Cart.
238	*
239	* @see woocommerce_cross_sell_display()
240	* @see woocommerce_cart_totals()
241	* @see wc_get_pay_buttons()
242	* @see woocommerce_button_proceed_to_checkout()
243	* @see wc_empty_cart_message()
244	*/
245	add_action( 'woocommerce_cart_collaterals', 'woocommerce_cross_sell_display' );
246	add_action( 'woocommerce_cart_collaterals', 'woocommerce_cart_totals', 10 );
247	add_action( 'woocommerce_proceed_to_checkout', 'wc_get_pay_buttons', 10 );
248	add_action( 'woocommerce_proceed_to_checkout', 'woocommerce_button_proceed_to_checkout', 20 );
249	add_action( 'woocommerce_cart_is_empty', 'wc_empty_cart_message', 10 );
250
251	/**
252	* Footer.
253	*
254	* @see wc_print_js()
255	* @see woocommerce_demo_store()
256	*/
257	add_action( 'wp_footer', 'wc_print_js', 25 );
258	add_action( 'wp_body_open', 'woocommerce_demo_store' );
259	add_action(
260	'wp_footer',
261	function () {
262	// Fallback for pre-WP5.2 themes that don't support wp_body_open.
263	if ( 0 === did_action( 'wp_body_open' ) ) {
264	woocommerce_demo_store();
265	}
266	}
267	);
268
269	/**
270	* Order details.
271	*
272	* @see woocommerce_order_details_table()
273	* @see woocommerce_order_again_button()
274	*/
275	add_action( 'woocommerce_view_order', 'woocommerce_order_details_table', 10 );
276	add_action( 'woocommerce_thankyou', 'woocommerce_order_details_table', 10 );
277	add_action( 'woocommerce_order_details_after_order_table', 'woocommerce_order_again_button' );
278
279	/**
280	* Order downloads.
281	*
282	* @see woocommerce_order_downloads_table()
283	*/
284	add_action( 'woocommerce_available_downloads', 'woocommerce_order_downloads_table', 10 );
285
286	/**
287	* Auth.
288	*
289	* @see woocommerce_output_auth_header()
290	* @see woocommerce_output_auth_footer()
291	*/
292	add_action( 'woocommerce_auth_page_header', 'woocommerce_output_auth_header', 10 );
293	add_action( 'woocommerce_auth_page_footer', 'woocommerce_output_auth_footer', 10 );
294
295	/**
296	* Comments.
297	*
298	* Disable Jetpack comments.
299	*/
300	add_filter( 'jetpack_comment_form_enabled_for_product', '__return_false' );
301
302	/**
303	* My Account.
304	*/
305	add_action( 'woocommerce_account_navigation', 'woocommerce_account_navigation' );
306	add_action( 'woocommerce_account_content', 'woocommerce_account_content' );
307	add_action( 'woocommerce_account_orders_endpoint', 'woocommerce_account_orders' );
308	add_action( 'woocommerce_account_view-order_endpoint', 'woocommerce_account_view_order' );
309	add_action( 'woocommerce_account_downloads_endpoint', 'woocommerce_account_downloads' );
310	add_action( 'woocommerce_account_edit-address_endpoint', 'woocommerce_account_edit_address' );
311	add_action( 'woocommerce_account_payment-methods_endpoint', 'woocommerce_account_payment_methods' );
312	add_action( 'woocommerce_account_add-payment-method_endpoint', 'woocommerce_account_add_payment_method' );
313	add_action( 'woocommerce_account_edit-account_endpoint', 'woocommerce_account_edit_account' );
314	add_action( 'woocommerce_register_form', 'wc_registration_privacy_policy_text', 20 );
315
316	/**
317	* Notices.
318	*/
319	add_action( 'woocommerce_cart_is_empty', 'woocommerce_output_all_notices', 5 );
320	add_action( 'woocommerce_shortcode_before_product_cat_loop', 'woocommerce_output_all_notices', 10 );
321	add_action( 'woocommerce_before_shop_loop', 'woocommerce_output_all_notices', 10 );
322	add_action( 'woocommerce_before_single_product', 'woocommerce_output_all_notices', 10 );
323	add_action( 'woocommerce_before_cart', 'woocommerce_output_all_notices', 10 );
324	add_action( 'woocommerce_before_checkout_form_cart_notices', 'woocommerce_output_all_notices', 10 );
325	add_action( 'woocommerce_before_checkout_form', 'woocommerce_output_all_notices', 10 );
326	add_action( 'woocommerce_account_content', 'woocommerce_output_all_notices', 5 );
327	add_action( 'woocommerce_before_customer_login_form', 'woocommerce_output_all_notices', 10 );
328	add_action( 'woocommerce_before_lost_password_form', 'woocommerce_output_all_notices', 10 );
329	add_action( 'before_woocommerce_pay', 'woocommerce_output_all_notices', 10 );
330	add_action( 'woocommerce_before_reset_password_form', 'woocommerce_output_all_notices', 10 );
331
332	/**
333	* Hooked blocks.
334	*/
335	add_action( 'after_switch_theme', 'wc_after_switch_theme', 10, 2 );
336