wc-page-functions.php — WooCommerce 3.7.0

woocommerce / includes / wc-page-functions.php

woocommerce / includes Last commit date

wc-page-functions.php

225 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	$endpoint_title = WC()->query->get_endpoint_title( $endpoint );
25	$title = $endpoint_title ? $endpoint_title : $title;
26
27	remove_filter( 'the_title', 'wc_page_endpoint_title' );
28	}
29
30	return $title;
31	}
32
33	add_filter( 'the_title', 'wc_page_endpoint_title' );
34
35	/**
36	* Retrieve page ids - used for myaccount, edit_address, shop, cart, checkout, pay, view_order, terms. returns -1 if no page is found.
37	*
38	* @param string $page Page slug.
39	* @return int
40	*/
41	function wc_get_page_id( $page ) {
42	if ( 'pay' === $page \|\| 'thanks' === $page ) {
43	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.' );
44
45	$page = 'checkout';
46	}
47	if ( 'change_password' === $page \|\| 'edit_address' === $page \|\| 'lost_password' === $page ) {
48	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.' );
49
50	$page = 'myaccount';
51	}
52
53	$page = apply_filters( 'woocommerce_get_' . $page . '_page_id', get_option( 'woocommerce_' . $page . '_page_id' ) );
54
55	return $page ? absint( $page ) : -1;
56	}
57
58	/**
59	* Retrieve page permalink.
60	*
61	* @param string $page page slug.
62	* @param string\|bool $fallback Fallback URL if page is not set. Defaults to home URL. @since 3.4.0.
63	* @return string
64	*/
65	function wc_get_page_permalink( $page, $fallback = null ) {
66	$page_id = wc_get_page_id( $page );
67	$permalink = 0 < $page_id ? get_permalink( $page_id ) : '';
68
69	if ( ! $permalink ) {
70	$permalink = is_null( $fallback ) ? get_home_url() : $fallback;
71	}
72
73	return apply_filters( 'woocommerce_get_' . $page . '_page_permalink', $permalink );
74	}
75
76	/**
77	* Get endpoint URL.
78	*
79	* Gets the URL for an endpoint, which varies depending on permalink settings.
80	*
81	* @param string $endpoint Endpoint slug.
82	* @param string $value Query param value.
83	* @param string $permalink Permalink.
84	*
85	* @return string
86	*/
87	function wc_get_endpoint_url( $endpoint, $value = '', $permalink = '' ) {
88	if ( ! $permalink ) {
89	$permalink = get_permalink();
90	}
91
92	// Map endpoint to options.
93	$query_vars = WC()->query->get_query_vars();
94	$endpoint = ! empty( $query_vars[ $endpoint ] ) ? $query_vars[ $endpoint ] : $endpoint;
95	$value = ( get_option( 'woocommerce_myaccount_edit_address_endpoint', 'edit-address' ) === $endpoint ) ? wc_edit_address_i18n( $value ) : $value;
96
97	if ( get_option( 'permalink_structure' ) ) {
98	if ( strstr( $permalink, '?' ) ) {
99	$query_string = '?' . wp_parse_url( $permalink, PHP_URL_QUERY );
100	$permalink = current( explode( '?', $permalink ) );
101	} else {
102	$query_string = '';
103	}
104	$url = trailingslashit( $permalink ) . trailingslashit( $endpoint );
105
106	if ( $value ) {
107	$url .= trailingslashit( $value );
108	}
109
110	$url .= $query_string;
111	} else {
112	$url = add_query_arg( $endpoint, $value, $permalink );
113	}
114
115	return apply_filters( 'woocommerce_get_endpoint_url', $url, $endpoint, $value, $permalink );
116	}
117
118	/**
119	* Hide menu items conditionally.
120	*
121	* @param array $items Navigation items.
122	* @return array
123	*/
124	function wc_nav_menu_items( $items ) {
125	if ( ! is_user_logged_in() ) {
126	$customer_logout = get_option( 'woocommerce_logout_endpoint', 'customer-logout' );
127
128	if ( ! empty( $customer_logout ) && ! empty( $items ) && is_array( $items ) ) {
129	foreach ( $items as $key => $item ) {
130	if ( empty( $item->url ) ) {
131	continue;
132	}
133	$path = wp_parse_url( $item->url, PHP_URL_PATH );
134	$query = wp_parse_url( $item->url, PHP_URL_QUERY );
135
136	if ( strstr( $path, $customer_logout ) \|\| strstr( $query, $customer_logout ) ) {
137	unset( $items[ $key ] );
138	}
139	}
140	}
141	}
142
143	return $items;
144	}
145	add_filter( 'wp_nav_menu_objects', 'wc_nav_menu_items', 10 );
146
147
148	/**
149	* Fix active class in nav for shop page.
150	*
151	* @param array $menu_items Menu items.
152	* @return array
153	*/
154	function wc_nav_menu_item_classes( $menu_items ) {
155	if ( ! is_woocommerce() ) {
156	return $menu_items;
157	}
158
159	$shop_page = wc_get_page_id( 'shop' );
160	$page_for_posts = (int) get_option( 'page_for_posts' );
161
162	if ( ! empty( $menu_items ) && is_array( $menu_items ) ) {
163	foreach ( $menu_items as $key => $menu_item ) {
164	$classes = (array) $menu_item->classes;
165	$menu_id = (int) $menu_item->object_id;
166
167	// Unset active class for blog page.
168	if ( $page_for_posts === $menu_id ) {
169	$menu_items[ $key ]->current = false;
170
171	if ( in_array( 'current_page_parent', $classes, true ) ) {
172	unset( $classes[ array_search( 'current_page_parent', $classes, true ) ] );
173	}
174
175	if ( in_array( 'current-menu-item', $classes, true ) ) {
176	unset( $classes[ array_search( 'current-menu-item', $classes, true ) ] );
177	}
178	} elseif ( is_shop() && $shop_page === $menu_id && 'page' === $menu_item->object ) {
179	// Set active state if this is the shop page link.
180	$menu_items[ $key ]->current = true;
181	$classes[] = 'current-menu-item';
182	$classes[] = 'current_page_item';
183
184	} elseif ( is_singular( 'product' ) && $shop_page === $menu_id ) {
185	// Set parent state if this is a product page.
186	$classes[] = 'current_page_parent';
187	}
188
189	$menu_items[ $key ]->classes = array_unique( $classes );
190	}
191	}
192
193	return $menu_items;
194	}
195	add_filter( 'wp_nav_menu_objects', 'wc_nav_menu_item_classes', 2 );
196
197
198	/**
199	* Fix active class in wp_list_pages for shop page.
200	*
201	* See details in https://github.com/woocommerce/woocommerce/issues/177.
202	*
203	* @param string $pages Pages list.
204	* @return string
205	*/
206	function wc_list_pages( $pages ) {
207	if ( ! is_woocommerce() ) {
208	return $pages;
209	}
210
211	// Remove current_page_parent class from any item.
212	$pages = str_replace( 'current_page_parent', '', $pages );
213	// Find shop_page_id through woocommerce options.
214	$shop_page = 'page-item-' . wc_get_page_id( 'shop' );
215
216	if ( is_shop() ) {
217	// Add current_page_item class to shop page.
218	return str_replace( $shop_page, $shop_page . ' current_page_item', $pages );
219	}
220
221	// Add current_page_parent class to shop page.
222	return str_replace( $shop_page, $shop_page . ' current_page_parent', $pages );
223	}
224	add_filter( 'wp_list_pages', 'wc_list_pages' );
225