wc-page-functions.php — WooCommerce 10.8.0-beta.2

woocommerce / includes / wc-page-functions.php

woocommerce / includes Last commit date

wc-page-functions.php

317 lines

1	<?php
2	/**
3	* WooCommerce Page Functions
4	*
5	* Functions related to pages and menus.
6	*
7	* @package WooCommerce\Functions
8	* @version 2.6.0
9	*/
10
11	defined( 'ABSPATH' ) \|\| exit;
12
13	/**
14	* Replace a page title with the endpoint title.
15	*
16	* @param string $title Post title.
17	* @return string
18	*/
19	function wc_page_endpoint_title( $title ) {
20	global $wp_query;
21
22	if ( ! is_null( $wp_query ) && ! is_admin() && is_main_query() && in_the_loop() && is_page() && is_wc_endpoint_url() ) {
23	$endpoint = WC()->query->get_current_endpoint();
24	$action = isset( $_GET['action'] ) ? sanitize_text_field( wp_unslash( $_GET['action'] ) ) : '';
25	$endpoint_title = WC()->query->get_endpoint_title( $endpoint, $action );
26	$title = $endpoint_title ? $endpoint_title : $title;
27
28	remove_filter( 'the_title', 'wc_page_endpoint_title' );
29	}
30
31	return $title;
32	}
33
34	add_filter( 'the_title', 'wc_page_endpoint_title' );
35
36	/**
37	* Replace the title part of the document title.
38	*
39	* @param array $title {
40	* The document title parts.
41	*
42	* @type string $title Title of the viewed page.
43	* @type string $page Optional. Page number if paginated.
44	* @type string $tagline Optional. Site description when on home page.
45	* @type string $site Optional. Site title when not on home page.
46	* }
47	* @return array
48	*/
49	function wc_page_endpoint_document_title_parts( $title ) {
50	global $wp_query;
51
52	if ( ! is_null( $wp_query ) && ! is_admin() && is_main_query() && is_page() && is_wc_endpoint_url() ) {
53	$endpoint = WC()->query->get_current_endpoint();
54	$action = isset( $_GET['action'] ) ? sanitize_text_field( wp_unslash( $_GET['action'] ) ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Recommended
55	$endpoint_title = WC()->query->get_endpoint_title( $endpoint, $action );
56	$title['title'] = $endpoint_title ? $endpoint_title : $title['title'];
57
58	remove_filter( 'document_title_parts', 'wc_page_endpoint_document_title_parts' );
59	}
60
61	return $title;
62	}
63
64	add_filter( 'document_title_parts', 'wc_page_endpoint_document_title_parts' );
65
66	/**
67	* Retrieve page ids - used for myaccount, edit_address, shop, cart, checkout, pay, view_order, terms. returns -1 if no page is found.
68	*
69	* @param string $page Page slug.
70	* @return int
71	*/
72	function wc_get_page_id( $page ) {
73	if ( 'pay' === $page \|\| 'thanks' === $page ) {
74	wc_deprecated_argument( __FUNCTION__, '2.1', 'The "pay" and "thanks" pages are no-longer used - an endpoint is added to the checkout instead. To get a valid link use the WC_Order::get_checkout_payment_url() or WC_Order::get_checkout_order_received_url() methods instead.' );
75
76	$page = 'checkout';
77	}
78	if ( 'change_password' === $page \|\| 'edit_address' === $page \|\| 'lost_password' === $page ) {
79	wc_deprecated_argument( __FUNCTION__, '2.1', 'The "change_password", "edit_address" and "lost_password" pages are no-longer used - an endpoint is added to the my-account instead. To get a valid link use the wc_customer_edit_account_url() function instead.' );
80
81	$page = 'myaccount';
82	}
83
84	$page = apply_filters( 'woocommerce_get_' . $page . '_page_id', get_option( 'woocommerce_' . $page . '_page_id' ) );
85
86	return $page ? absint( $page ) : -1;
87	}
88
89	/**
90	* Retrieve page permalink.
91	*
92	* @param string $page page slug.
93	* @param string\|bool $fallback Fallback URL if page is not set. Defaults to home URL. @since 3.4.0.
94	* @return string
95	*/
96	function wc_get_page_permalink( $page, $fallback = null ) {
97	$page_id = wc_get_page_id( $page );
98	$permalink = 0 < $page_id ? get_permalink( $page_id ) : '';
99
100	if ( ! $permalink ) {
101	$permalink = is_null( $fallback ) ? get_home_url() : $fallback;
102	}
103
104	return apply_filters( 'woocommerce_get_' . $page . '_page_permalink', $permalink );
105	}
106
107	/**
108	* Get endpoint URL.
109	*
110	* Gets the URL for an endpoint, which varies depending on permalink settings.
111	*
112	* @param string $endpoint Endpoint slug.
113	* @param string $value Query param value.
114	* @param string $permalink Permalink.
115	*
116	* @return string
117	*/
118	function wc_get_endpoint_url( $endpoint, $value = '', $permalink = '' ) {
119	if ( ! $permalink ) {
120	$permalink = get_permalink();
121	}
122
123	// Map endpoint to options.
124	$query_vars = WC()->query->get_query_vars();
125	$endpoint = ! empty( $query_vars[ $endpoint ] ) ? $query_vars[ $endpoint ] : $endpoint;
126	$value = ( get_option( 'woocommerce_myaccount_edit_address_endpoint', 'edit-address' ) === $endpoint ) ? wc_edit_address_i18n( $value ) : $value;
127
128	if ( get_option( 'permalink_structure' ) ) {
129	if ( strstr( $permalink, '?' ) ) {
130	$query_string = '?' . wp_parse_url( $permalink, PHP_URL_QUERY );
131	$permalink = current( explode( '?', $permalink ) );
132	} else {
133	$query_string = '';
134	}
135	$url = trailingslashit( $permalink );
136
137	if ( $value ) {
138	$url .= trailingslashit( $endpoint ) . user_trailingslashit( $value );
139	} else {
140	$url .= user_trailingslashit( $endpoint );
141	}
142
143	$url .= $query_string;
144	} else {
145	$url = add_query_arg( $endpoint, $value, $permalink );
146	}
147
148	return apply_filters( 'woocommerce_get_endpoint_url', $url, $endpoint, $value, $permalink );
149	}
150
151	/**
152	* Get the tokenized Review Order URL for the given order.
153	*
154	* Top-level rewrite: returns `/review-order/{id}/?key={order_key}` on pretty
155	* permalinks and `/?review-order={id}&key={order_key}` on plain permalinks.
156	* The order key allows guest customers to reach the page without logging in.
157	*
158	* @since 10.8.0
159	* @param WC_Order $order Order object.
160	* @return string
161	*/
162	function wc_get_review_order_url( $order ) {
163	if ( ! $order instanceof WC_Order ) {
164	return '';
165	}
166
167	return \Automattic\WooCommerce\Internal\OrderReviews\Endpoint::get_url( $order );
168	}
169
170	/**
171	* Hide or adjust menu items conditionally.
172	*
173	* @param array $items Navigation items.
174	* @return array
175	*/
176	function wc_nav_menu_items( $items ) {
177	$logout_endpoint = get_option( 'woocommerce_logout_endpoint', 'customer-logout' );
178
179	if ( ! empty( $logout_endpoint ) && ! empty( $items ) && is_array( $items ) ) {
180	foreach ( $items as $key => $item ) {
181	if ( empty( $item->url ) ) {
182	continue;
183	}
184
185	$path = wp_parse_url( $item->url, PHP_URL_PATH ) ?? '';
186	$query = wp_parse_url( $item->url, PHP_URL_QUERY ) ?? '';
187	$is_logout_link = strstr( $path, $logout_endpoint ) \|\| strstr( $query, $logout_endpoint );
188
189	if ( ! $is_logout_link ) {
190	continue;
191	}
192
193	if ( is_user_logged_in() ) {
194	$items[ $key ]->url = wp_nonce_url( $item->url, 'customer-logout' );
195	} else {
196	unset( $items[ $key ] );
197	}
198	}
199	}
200
201	return $items;
202	}
203	add_filter( 'wp_nav_menu_objects', 'wc_nav_menu_items', 10 );
204
205	/**
206	* Hide menu items in navigation blocks conditionally.
207	*
208	* Does the same thing as wc_nav_menu_items but for block themes.
209	*
210	* @since 9.3.0
211	* @param \WP_Block_list $inner_blocks Inner blocks.
212	* @return \WP_Block_list
213	*/
214	function wc_nav_menu_inner_blocks( $inner_blocks ) {
215	$logout_endpoint = get_option( 'woocommerce_logout_endpoint', 'customer-logout' );
216
217	if ( ! empty( $logout_endpoint ) && $inner_blocks ) {
218	foreach ( $inner_blocks as $inner_block_key => $inner_block ) {
219	$url = $inner_block->parsed_block['attrs']['url'] ?? '';
220	$path = wp_parse_url( $url, PHP_URL_PATH ) ?? '';
221	$query = wp_parse_url( $url, PHP_URL_QUERY ) ?? '';
222	$is_logout_link = strstr( $path, $logout_endpoint ) \|\| strstr( $query, $logout_endpoint );
223
224	if ( ! $is_logout_link ) {
225	continue;
226	}
227
228	if ( is_user_logged_in() ) {
229	$inner_block->parsed_block['attrs']['url'] = wp_nonce_url( $inner_block->parsed_block['attrs']['url'], 'customer-logout' );
230	} else {
231	unset( $inner_blocks[ $inner_block_key ] );
232	}
233	}
234	}
235
236	return $inner_blocks;
237	}
238	add_filter( 'block_core_navigation_render_inner_blocks', 'wc_nav_menu_inner_blocks' );
239
240	/**
241	* Fix active class in nav for shop page.
242	*
243	* @param array $menu_items Menu items.
244	* @return array
245	*/
246	function wc_nav_menu_item_classes( $menu_items ) {
247	if ( ! is_woocommerce() ) {
248	return $menu_items;
249	}
250
251	$shop_page = wc_get_page_id( 'shop' );
252	$page_for_posts = (int) get_option( 'page_for_posts' );
253
254	if ( ! empty( $menu_items ) && is_array( $menu_items ) ) {
255	foreach ( $menu_items as $key => $menu_item ) {
256	$classes = (array) $menu_item->classes;
257	$menu_id = (int) $menu_item->object_id;
258
259	// Unset active class for blog page.
260	if ( $page_for_posts === $menu_id && isset( $menu_item->object ) && 'page' === $menu_item->object ) {
261	$menu_items[ $key ]->current = false;
262
263	if ( in_array( 'current_page_parent', $classes, true ) ) {
264	unset( $classes[ array_search( 'current_page_parent', $classes, true ) ] );
265	}
266
267	if ( in_array( 'current-menu-item', $classes, true ) ) {
268	unset( $classes[ array_search( 'current-menu-item', $classes, true ) ] );
269	}
270	} elseif ( is_shop() && $shop_page === $menu_id && 'page' === $menu_item->object ) {
271	// Set active state if this is the shop page link.
272	$menu_items[ $key ]->current = true;
273	$classes[] = 'current-menu-item';
274	$classes[] = 'current_page_item';
275
276	} elseif ( is_singular( 'product' ) && $shop_page === $menu_id ) {
277	// Set parent state if this is a product page.
278	$classes[] = 'current_page_parent';
279	}
280
281	$menu_items[ $key ]->classes = array_unique( $classes );
282	}
283	}
284
285	return $menu_items;
286	}
287	add_filter( 'wp_nav_menu_objects', 'wc_nav_menu_item_classes', 2 );
288
289
290	/**
291	* Fix active class in wp_list_pages for shop page.
292	*
293	* See details in https://github.com/woocommerce/woocommerce/issues/177.
294	*
295	* @param string $pages Pages list.
296	* @return string
297	*/
298	function wc_list_pages( $pages ) {
299	if ( ! is_woocommerce() ) {
300	return $pages;
301	}
302
303	// Remove current_page_parent class from any item.
304	$pages = str_replace( 'current_page_parent', '', $pages );
305	// Find shop_page_id through woocommerce options.
306	$shop_page = 'page-item-' . wc_get_page_id( 'shop' );
307
308	if ( is_shop() ) {
309	// Add current_page_item class to shop page.
310	return str_replace( $shop_page, $shop_page . ' current_page_item', $pages );
311	}
312
313	// Add current_page_parent class to shop page.
314	return str_replace( $shop_page, $shop_page . ' current_page_parent', $pages );
315	}
316	add_filter( 'wp_list_pages', 'wc_list_pages' );
317