class-wc-breadcrumb.php — WooCommerce 10.2.3

woocommerce / includes / class-wc-breadcrumb.php

woocommerce / includes Last commit date

class-wc-breadcrumb.php

381 lines

1	<?php
2	/**
3	* WC_Breadcrumb class.
4	*
5	* @package WooCommerce\Classes
6	* @version 2.3.0
7	*/
8
9	defined( 'ABSPATH' ) \|\| exit;
10
11	/**
12	* Breadcrumb class.
13	*/
14	class WC_Breadcrumb {
15
16	/**
17	* Breadcrumb trail.
18	*
19	* @var array
20	*/
21	protected $crumbs = array();
22
23	/**
24	* Add a crumb so we don't get lost.
25	*
26	* @param string $name Name.
27	* @param string $link Link.
28	*/
29	public function add_crumb( $name, $link = '' ) {
30	$this->crumbs[] = array(
31	wp_strip_all_tags( $name ),
32	$link,
33	);
34	}
35
36	/**
37	* Reset crumbs.
38	*/
39	public function reset() {
40	$this->crumbs = array();
41	}
42
43	/**
44	* Get the breadcrumb.
45	*
46	* @return array
47	*/
48	public function get_breadcrumb() {
49	return apply_filters( 'woocommerce_get_breadcrumb', $this->crumbs, $this );
50	}
51
52	/**
53	* Generate breadcrumb trail.
54	*
55	* @return array of breadcrumbs
56	*/
57	public function generate() {
58	$conditionals = array(
59	'is_home',
60	'is_404',
61	'is_attachment',
62	'is_single',
63	'is_product_category',
64	'is_product_tag',
65	'is_shop',
66	'is_page',
67	'is_post_type_archive',
68	'is_category',
69	'is_tag',
70	'is_author',
71	'is_date',
72	'is_tax',
73	);
74
75	if ( ( ! is_front_page() && ! ( is_post_type_archive() && intval( get_option( 'page_on_front' ) ) === wc_get_page_id( 'shop' ) ) ) \|\| is_paged() ) {
76	foreach ( $conditionals as $conditional ) {
77	if ( call_user_func( $conditional ) ) {
78	call_user_func( array( $this, 'add_crumbs_' . substr( $conditional, 3 ) ) );
79	break;
80	}
81	}
82
83	$this->search_trail();
84	$this->paged_trail();
85
86	return $this->get_breadcrumb();
87	}
88
89	return array();
90	}
91
92	/**
93	* Prepend the shop page to shop breadcrumbs.
94	*/
95	protected function prepend_shop_page() {
96	$permalinks = wc_get_permalink_structure();
97	$shop_page_id = wc_get_page_id( 'shop' );
98	$shop_page = get_post( $shop_page_id );
99
100	// If permalinks contain the shop page in the URI prepend the breadcrumb with shop.
101	if ( $shop_page_id && $shop_page && isset( $permalinks['product_base'] ) && strstr( $permalinks['product_base'], '/' . $shop_page->post_name ) && intval( get_option( 'page_on_front' ) ) !== $shop_page_id ) {
102	$this->add_crumb( get_the_title( $shop_page ), get_permalink( $shop_page ) );
103	}
104	}
105
106	/**
107	* Is home trail..
108	*/
109	protected function add_crumbs_home() {
110	$this->add_crumb( single_post_title( '', false ) );
111	}
112
113	/**
114	* 404 trail.
115	*/
116	protected function add_crumbs_404() {
117	$this->add_crumb( __( 'Error 404', 'woocommerce' ) );
118	}
119
120	/**
121	* Attachment trail.
122	*/
123	protected function add_crumbs_attachment() {
124	global $post;
125
126	$this->add_crumbs_single( $post->post_parent, get_permalink( $post->post_parent ) );
127	$this->add_crumb( get_the_title(), get_permalink() );
128	}
129
130	/**
131	* Single post trail.
132	*
133	* @param int $post_id Post ID.
134	* @param string $permalink Post permalink.
135	*/
136	protected function add_crumbs_single( $post_id = 0, $permalink = '' ) {
137	if ( ! $post_id ) {
138	global $post;
139	} else {
140	$post = get_post( $post_id ); // WPCS: override ok.
141	}
142
143	if ( ! $permalink ) {
144	$permalink = get_permalink( $post );
145	}
146
147	if ( 'product' === get_post_type( $post ) ) {
148	$this->prepend_shop_page();
149
150	$terms = wc_get_product_terms(
151	$post->ID,
152	'product_cat',
153	apply_filters(
154	'woocommerce_breadcrumb_product_terms_args',
155	array(
156	'orderby' => 'parent',
157	'order' => 'DESC',
158	)
159	)
160	);
161
162	if ( $terms ) {
163	$main_term = apply_filters( 'woocommerce_breadcrumb_main_term', $terms[0], $terms );
164	$this->term_ancestors( $main_term->term_id, 'product_cat' );
165	$this->add_crumb( $main_term->name, get_term_link( $main_term ) );
166	}
167	} elseif ( 'post' !== get_post_type( $post ) ) {
168	$post_type = get_post_type_object( get_post_type( $post ) );
169
170	if ( ! empty( $post_type->has_archive ) ) {
171	$this->add_crumb( $post_type->labels->singular_name, get_post_type_archive_link( get_post_type( $post ) ) );
172	}
173	} else {
174	$cat = current( get_the_category( $post ) );
175	if ( $cat ) {
176	$this->term_ancestors( $cat->term_id, 'category' );
177	$this->add_crumb( $cat->name, get_term_link( $cat ) );
178	}
179	}
180
181	$this->add_crumb( get_the_title( $post ), $permalink );
182	}
183
184	/**
185	* Page trail.
186	*/
187	protected function add_crumbs_page() {
188	global $post;
189
190	if ( $post->post_parent ) {
191	$parent_crumbs = array();
192	$parent_id = $post->post_parent;
193
194	while ( $parent_id ) {
195	$page = get_post( $parent_id );
196	$parent_id = $page->post_parent;
197	$parent_crumbs[] = array( get_the_title( $page->ID ), get_permalink( $page->ID ) );
198	}
199
200	$parent_crumbs = array_reverse( $parent_crumbs );
201
202	foreach ( $parent_crumbs as $crumb ) {
203	$this->add_crumb( $crumb[0], $crumb[1] );
204	}
205	}
206
207	$this->add_crumb( get_the_title(), get_permalink() );
208	$this->endpoint_trail();
209	}
210
211	/**
212	* Product category trail.
213	*/
214	protected function add_crumbs_product_category() {
215	$current_term = $GLOBALS['wp_query']->get_queried_object();
216
217	$this->prepend_shop_page();
218	$this->term_ancestors( $current_term->term_id, 'product_cat' );
219	$this->add_crumb( $current_term->name, get_term_link( $current_term, 'product_cat' ) );
220	}
221
222	/**
223	* Product tag trail.
224	*/
225	protected function add_crumbs_product_tag() {
226	$current_term = $GLOBALS['wp_query']->get_queried_object();
227
228	$this->prepend_shop_page();
229
230	/* translators: %s: product tag */
231	$this->add_crumb( sprintf( __( 'Products tagged “%s”', 'woocommerce' ), $current_term->name ), get_term_link( $current_term, 'product_tag' ) );
232	}
233
234	/**
235	* Shop breadcrumb.
236	*/
237	protected function add_crumbs_shop() {
238	if ( intval( get_option( 'page_on_front' ) ) === wc_get_page_id( 'shop' ) ) {
239	return;
240	}
241
242	$_name = wc_get_page_id( 'shop' ) ? get_the_title( wc_get_page_id( 'shop' ) ) : '';
243
244	if ( ! $_name ) {
245	$product_post_type = get_post_type_object( 'product' );
246	$_name = $product_post_type->labels->name;
247	}
248
249	$this->add_crumb( $_name, get_post_type_archive_link( 'product' ) );
250	}
251
252	/**
253	* Post type archive trail.
254	*/
255	protected function add_crumbs_post_type_archive() {
256	$post_type = get_post_type_object( get_post_type() );
257
258	if ( $post_type ) {
259	$this->add_crumb( $post_type->labels->name, get_post_type_archive_link( get_post_type() ) );
260	}
261	}
262
263	/**
264	* Category trail.
265	*/
266	protected function add_crumbs_category() {
267	$this_category = get_category( $GLOBALS['wp_query']->get_queried_object() );
268
269	if ( 0 !== intval( $this_category->parent ) ) {
270	$this->term_ancestors( $this_category->term_id, 'category' );
271	}
272
273	$this->add_crumb( single_cat_title( '', false ), get_category_link( $this_category->term_id ) );
274	}
275
276	/**
277	* Tag trail.
278	*/
279	protected function add_crumbs_tag() {
280	$queried_object = $GLOBALS['wp_query']->get_queried_object();
281
282	/* translators: %s: tag name */
283	$this->add_crumb( sprintf( __( 'Posts tagged “%s”', 'woocommerce' ), single_tag_title( '', false ) ), get_tag_link( $queried_object->term_id ) );
284	}
285
286	/**
287	* Add crumbs for date based archives.
288	*/
289	protected function add_crumbs_date() {
290	if ( is_year() \|\| is_month() \|\| is_day() ) {
291	$this->add_crumb( get_the_time( 'Y' ), get_year_link( get_the_time( 'Y' ) ) );
292	}
293	if ( is_month() \|\| is_day() ) {
294	$this->add_crumb( get_the_time( 'F' ), get_month_link( get_the_time( 'Y' ), get_the_time( 'm' ) ) );
295	}
296	if ( is_day() ) {
297	$this->add_crumb( get_the_time( 'd' ) );
298	}
299	}
300
301	/**
302	* Add crumbs for taxonomies
303	*/
304	protected function add_crumbs_tax() {
305	$this_term = $GLOBALS['wp_query']->get_queried_object();
306	$taxonomy = get_taxonomy( $this_term->taxonomy );
307
308	$this->add_crumb( $taxonomy->labels->name );
309
310	if ( 0 !== intval( $this_term->parent ) ) {
311	$this->term_ancestors( $this_term->term_id, $this_term->taxonomy );
312	}
313
314	$this->add_crumb( single_term_title( '', false ), get_term_link( $this_term->term_id, $this_term->taxonomy ) );
315	}
316
317	/**
318	* Add a breadcrumb for author archives.
319	*/
320	protected function add_crumbs_author() {
321	global $author;
322
323	$userdata = get_userdata( $author );
324
325	/* translators: %s: author name */
326	$this->add_crumb( sprintf( __( 'Author: %s', 'woocommerce' ), $userdata->display_name ) );
327	}
328
329	/**
330	* Add crumbs for a term.
331	*
332	* @param int $term_id Term ID.
333	* @param string $taxonomy Taxonomy.
334	*/
335	protected function term_ancestors( $term_id, $taxonomy ) {
336	$ancestors = get_ancestors( $term_id, $taxonomy );
337	$ancestors = array_reverse( $ancestors );
338
339	foreach ( $ancestors as $ancestor ) {
340	$ancestor = get_term( $ancestor, $taxonomy );
341
342	if ( ! is_wp_error( $ancestor ) && $ancestor ) {
343	$this->add_crumb( $ancestor->name, get_term_link( $ancestor ) );
344	}
345	}
346	}
347
348	/**
349	* Endpoints.
350	*/
351	protected function endpoint_trail() {
352	$action = isset( $_GET['action'] ) ? sanitize_text_field( wp_unslash( $_GET['action'] ) ) : '';
353	$endpoint = is_wc_endpoint_url() ? WC()->query->get_current_endpoint() : '';
354	$endpoint_title = $endpoint ? WC()->query->get_endpoint_title( $endpoint, $action ) : '';
355
356	if ( $endpoint_title ) {
357	$this->add_crumb( $endpoint_title );
358	}
359	}
360
361	/**
362	* Add a breadcrumb for search results.
363	*/
364	protected function search_trail() {
365	if ( is_search() ) {
366	/* translators: %s: search term */
367	$this->add_crumb( sprintf( __( 'Search results for “%s”', 'woocommerce' ), get_search_query() ), remove_query_arg( 'paged' ) );
368	}
369	}
370
371	/**
372	* Add a breadcrumb for pagination.
373	*/
374	protected function paged_trail() {
375	if ( get_query_var( 'paged' ) && 'subcategories' !== woocommerce_get_loop_display_mode() ) {
376	/* translators: %d: page number */
377	$this->add_crumb( sprintf( __( 'Page %d', 'woocommerce' ), get_query_var( 'paged' ) ) );
378	}
379	}
380	}
381