-
Notifications
You must be signed in to change notification settings - Fork 15
/
Copy pathbreadcrumb-trail.php
1225 lines (964 loc) · 39.2 KB
/
breadcrumb-trail.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* Breadcrumb Trail - A breadcrumb menu script for WordPress.
*
* Breadcrumb Trail is a script for showing a breadcrumb trail for any type of page. It tries to
* anticipate any type of structure and display the best possible trail that matches your site's
* permalink structure. While not perfect, it attempts to fill in the gaps left by many other
* breadcrumb scripts.
*
* This program is free software; you can redistribute it and/or modify it under the terms of the GNU
* General Public License as published by the Free Software Foundation; either version 2 of the License,
* or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
* even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*
* @package BreadcrumbTrail
* @version 0.6.1
* @author Justin Tadlock <[email protected]>
* @copyright Copyright (c) 2008 - 2013, Justin Tadlock
* @link http://themehybrid.com/plugins/breadcrumb-trail
* @license http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
*/
/**
* Shows a breadcrumb for all types of pages. This is a wrapper function for the Breadcrumb_Trail class,
* which should be used in theme templates.
*
* @since 0.1.0
* @access public
* @param array $args Arguments to pass to Breadcrumb_Trail.
* @return void
*/
function breadcrumb_trail( $args = array() ) {
if ( function_exists( 'is_bbpress' ) && is_bbpress() )
$breadcrumb = new bbPress_Breadcrumb_Trail( $args );
else
$breadcrumb = new Breadcrumb_Trail( $args );
$breadcrumb->trail();
}
/**
* Creates a breadcrumbs menu for the site based on the current page that's being viewed by the user.
*
* @since 0.6.0
*/
class Breadcrumb_Trail {
/**
* Array of items belonging to the current breadcrumb trail.
*
* @since 0.1.0
* @access public
* @var array
*/
public $items = array();
/**
* Arguments used to build the breadcrumb trail.
*
* @since 0.1.0
* @access public
* @var array
*/
public $args = array();
/**
* Sets up the breadcrumb trail.
*
* @since 0.6.0
* @access public
* @param array $args The arguments for how to build the breadcrumb trail.
* @return void
*/
public function __construct( $args = array() ) {
/* Remove the bbPress breadcrumbs. */
add_filter( 'bbp_get_breadcrumb', '__return_false' );
$defaults = array(
'container' => 'div',
'separator' => '/',
'before' => '',
'after' => '',
'show_on_front' => true,
'network' => false,
//'show_edit_link' => false,
'show_title' => true,
'show_browse' => true,
'echo' => true,
/* Post taxonomy (examples follow). */
'post_taxonomy' => array(
// 'post' => 'post_tag',
// 'book' => 'genre',
),
/* Labels for text used (see Breadcrumb_Trail::default_labels). */
'labels' => array()
);
$this->args = apply_filters( 'breadcrumb_trail_args', wp_parse_args( $args, $defaults ) );
/* Merge the user-added labels with the defaults. */
$this->args['labels'] = wp_parse_args( $this->args['labels'], $this->default_labels() );
$this->do_trail_items();
}
/**
* Formats and outputs the breadcrumb trail.
*
* @since 0.6.0
* @access public
* @return string
*/
public function trail() {
$breadcrumb = '';
/* Connect the breadcrumb trail if there are items in the trail. */
if ( !empty( $this->items ) && is_array( $this->items ) ) {
/* Make sure we have a unique array of items. */
$this->items = array_unique( $this->items );
/* Open the breadcrumb trail containers. */
$breadcrumb = "\n\t\t" . '<' . tag_escape( $this->args['container'] ) . ' class="breadcrumb-trail breadcrumbs" itemprop="breadcrumb">';
/* If $before was set, wrap it in a container. */
$breadcrumb .= ( !empty( $this->args['before'] ) ? "\n\t\t\t" . '<span class="trail-before">' . $this->args['before'] . '</span> ' . "\n\t\t\t" : '' );
/* Add 'browse' label if it should be shown. */
if ( true === $this->args['show_browse'] )
$breadcrumb .= "\n\t\t\t" . '<span class="trail-browse">' . $this->args['labels']['browse'] . '</span> ';
/* Adds the 'trail-begin' class around first item if there's more than one item. */
if ( 1 < count( $this->items ) )
array_unshift( $this->items, '<span class="trail-begin">' . array_shift( $this->items ) . '</span>' );
/* Adds the 'trail-end' class around last item. */
array_push( $this->items, '<span class="trail-end">' . array_pop( $this->items ) . '</span>' );
/* Format the separator. */
$separator = ( !empty( $this->args['separator'] ) ? '<span class="sep">' . $this->args['separator'] . '</span>' : '<span class="sep">/</span>' );
/* Join the individual trail items into a single string. */
$breadcrumb .= join( "\n\t\t\t {$separator} ", $this->items );
/* If $after was set, wrap it in a container. */
$breadcrumb .= ( !empty( $this->args['after'] ) ? "\n\t\t\t" . ' <span class="trail-after">' . $this->args['after'] . '</span>' : '' );
/* Close the breadcrumb trail containers. */
$breadcrumb .= "\n\t\t" . '</' . tag_escape( $this->args['container'] ) . '>';
}
/* Allow developers to filter the breadcrumb trail HTML. */
$breadcrumb = apply_filters( 'breadcrumb_trail', $breadcrumb, $this->args );
if ( true === $this->args['echo'] )
echo $breadcrumb;
else
return $breadcrumb;
}
/**
* Returns an array of the default labels.
*
* @since 0.6.0
* @access public
* @return array
*/
public function default_labels() {
$labels = array(
'browse' => __( 'Browse:', 'breadcrumb-trail' ),
'home' => __( 'Home', 'breadcrumb-trail' ),
'search' => __( 'Search results for "%s"', 'breadcrumb-trail' ),
'error_404' => __( '404 Not Found', 'breadcrumb-trail' ),
'paged' => __( 'Page %d', 'breadcrumb-trail' ),
'archives' => __( 'Archives', 'breadcrumb-trail' ),
'archive_minute_hour' => __( 'g:i a', 'breadcrumb-trail' ),
'archive_minute' => __( 'Minute %d', 'breadcrumb-trail' ),
'archive_hour' => __( 'g a', 'breadcrumb-trail' ),
'archive_day' => __( 'd', 'breadcrumb-trail' ),
'archive_week' => __( 'Week %d', 'breadcrumb-trail' ),
'archive_month' => __( 'F', 'breadcrumb-trail' ),
'archive_year' => __( 'Y', 'breadcrumb-trail' ),
// 'edit' => __( 'Edit', 'breadcrumb-trail' ), // @todo Implement edit link
);
return $labels;
}
/**
* Runs through the various WordPress conditional tags to check the current page being viewed. Once
* a condition is met, a specific method is launched to add items to the $items array.
*
* @since 0.6.0
* @access public
* @return void
*/
public function do_trail_items() {
/* If viewing the front page. */
if ( is_front_page() ) {
$this->do_front_page_items();
}
/* If not viewing the front page. */
else {
/* Add the network and site home links. */
$this->do_network_home_link();
$this->do_site_home_link();
/* If viewing the home/blog page. */
if ( is_home() ) {
$this->do_posts_page_items();
}
/* If viewing a single post. */
elseif ( is_singular() ) {
$this->do_singular_items();
}
/* If viewing an archive page. */
elseif ( is_archive() ) {
if ( is_post_type_archive() )
$this->do_post_type_archive_items();
elseif ( is_category() || is_tag() || is_tax() )
$this->do_term_archive_items();
elseif ( is_author() )
$this->do_user_archive_items();
elseif ( get_query_var( 'minute' ) && get_query_var( 'hour' ) )
$this->do_minute_hour_archive_items();
elseif ( get_query_var( 'minute' ) )
$this->do_minute_archive_items();
elseif ( get_query_var( 'hour' ) )
$this->do_hour_archive_items();
elseif ( is_day() )
$this->do_day_archive_items();
elseif ( get_query_var( 'w' ) )
$this->do_week_archive_items();
elseif ( is_month() )
$this->do_month_archive_items();
elseif ( is_year() )
$this->do_year_archive_items();
else
$this->do_default_archive_items();
}
/* If viewing a search results page. */
elseif ( is_search() ) {
$this->do_search_items();
}
/* If viewing the 404 page. */
elseif ( is_404() ) {
$this->do_404_items();
}
}
/* Add paged items if they exist. */
$this->do_paged_items();
/* Allow developers to overwrite the items for the breadcrumb trail. */
$this->items = apply_filters( 'breadcrumb_trail_items', $this->items, $this->args );
}
/**
* Gets front items based on $wp_rewrite->front.
*
* @since 0.6.0
* @access public
* @return void
*/
public function do_rewrite_front_items() {
global $wp_rewrite;
if ( $wp_rewrite->front )
$this->do_path_parents( $wp_rewrite->front );
}
/**
* Adds the page/paged number to the items array.
*
* @since 0.6.0
* @access public
* @return void
*/
public function do_paged_items() {
/* If viewing a paged singular post. */
if ( is_singular() && 1 < get_query_var( 'page' ) && true === $this->args['show_title'] )
$this->items[] = sprintf( $this->args['labels']['paged'], absint( get_query_var( 'page' ) ) );
/* If viewing a paged archive-type page. */
elseif ( is_paged() && true === $this->args['show_title'] )
$this->items[] = sprintf( $this->args['labels']['paged'], absint( get_query_var( 'paged' ) ) );
}
/**
* Adds the network (all sites) home page link to the items array.
*
* @since 0.6.0
* @access public
* @return void
*/
public function do_network_home_link() {
if ( is_multisite() && !is_main_site() && true === $this->args['network'] )
$this->items[] = '<a href="' . network_home_url() . '" title="' . esc_attr( $this->args['labels']['home'] ) . '" rel="home">' . $this->args['labels']['home'] . '</a>';
}
/**
* Adds the current site's home page link to the items array.
*
* @since 0.6.0
* @access public
* @return void
*/
public function do_site_home_link() {
$label = ( is_multisite() && !is_main_site() && true === $this->args['network'] ) ? get_bloginfo( 'name' ) : $this->args['labels']['home'];
$rel = ( is_multisite() && !is_main_site() && true === $this->args['network'] ) ? '' : ' rel="home"';
$this->items[] = '<a href="' . home_url() . '" title="' . esc_attr( get_bloginfo( 'name' ) ) . '"' . $rel .'>' . $label . '</a>';
}
/**
* Adds items for the front page to the items array.
*
* @since 0.6.0
* @access public
* @return void
*/
public function do_front_page_items() {
/* Only show front items if the 'show_on_front' argument is set to 'true'. */
if ( true === $this->args['show_on_front'] || is_paged() || ( is_singular() && 1 < get_query_var( 'page' ) ) ) {
/* If on a paged view, add the home link items. */
if ( is_paged() ) {
$this->do_network_home_link();
$this->do_site_home_link();
}
/* If on the main front page, add the network home link item and the home item. */
else {
$this->do_network_home_link();
if ( true === $this->args['show_title'] )
$this->items[] = ( is_multisite() && true === $this->args['network'] ) ? get_bloginfo( 'name' ) : $this->args['labels']['home'];
}
}
}
/**
* Adds items for the posts page (i.e., is_home()) to the items array.
*
* @since 0.6.0
* @access public
* @return void
*/
public function do_posts_page_items() {
/* Get the post ID and post. */
$post_id = get_queried_object_id();
$post = get_page( $post_id );
/* If the post has parents, add them to the trail. */
if ( 0 < $post->post_parent )
$this->do_post_parents( $post->post_parent );
/* Get the page title. */
$title = get_the_title( $post_id );
/* Add the posts page item. */
if ( is_paged() )
$this->items[] = '<a href="' . get_permalink( $post_id ) . '" title="' . esc_attr( $title ) . '">' . $title . '</a>';
elseif ( $title && true === $this->args['show_title'] )
$this->items[] = $title;
}
/**
* Adds singular post items to the items array.
*
* @since 0.6.0
* @access public
* @return void
*/
public function do_singular_items() {
/* Get the queried post. */
$post = get_queried_object();
$post_id = get_queried_object_id();
/* If the post has a parent, follow the parent trail. */
if ( 0 < $post->post_parent )
$this->do_post_parents( $post->post_parent );
/* If the post doesn't have a parent, get its hierarchy based off the post type. */
else
$this->do_post_hierarchy( $post_id );
/* Display terms for specific post type taxonomy if requested. */
$this->do_post_terms( $post_id );
/* End with the post title. */
if ( $post_title = single_post_title( '', false ) ) {
if ( 1 < get_query_var( 'page' ) )
$this->items[] = '<a href="' . get_permalink( $post_id ) . '" title="' . esc_attr( $post_title ) . '">' . $post_title . '</a>';
elseif ( true === $this->args['show_title'] )
$this->items[] = $post_title;
}
}
/**
* Adds a specific post's parents to the items array.
*
* @since 0.6.0
* @access public
* @param int $post_id The ID of the post to get the parents of.
* @return void
*/
public function do_post_parents( $post_id ) {
$parents = array();
while ( $post_id ) {
/* Get the post by ID. */
$post = get_post( $post_id );
/* Add the formatted post link to the array of parents. */
$parents[] = '<a href="' . get_permalink( $post_id ) . '" title="' . esc_attr( get_the_title( $post_id ) ) . '">' . get_the_title( $post_id ) . '</a>';
/* If there's no longer a post parent, brea out of the loop. */
if ( 0 >= $post->post_parent )
break;
/* Change the post ID to the parent post to continue looping. */
$post_id = $post->post_parent;
}
/* Get the post hierarchy based off the final parent post. */
$this->do_post_hierarchy( $post_id );
/* Merge the parent items into the items array. */
$this->items = array_merge( $this->items, array_reverse( $parents ) );
}
/**
* Adds a post's terms from a specific taxonomy to the items array.
*
* @since 0.6.0
* @access public
* @param int $post_id The ID of the post to get the terms for.
* @return void
*/
public function do_post_terms( $post_id ) {
/* Get the post type. */
$post_type = get_post_type( $post_id );
/* Add the terms of the taxonomy for this post. */
if ( !empty( $this->args['post_taxonomy'][ $post_type ] ) )
$this->items[] = get_the_term_list( $post_id, $this->args['post_taxonomy'][ $post_type ], '', ', ', '' );
}
/**
* Adds a specific post's hierarchy to the items array. The hierarchy is determined by post type's
* rewrite arguments and whether it has an archive page.
*
* @since 0.6.0
* @access public
* @param int $post_id The ID of the post to get the hierarchy for.
* @return void
*/
public function do_post_hierarchy( $post_id ) {
/* Get the post type. */
$post_type = get_post_type( $post_id );
$post_type_object = get_post_type_object( $post_type );
/* If this is the 'post' post type, get the rewrite front items and map the rewrite tags. */
if ( 'post' === $post_type ) {
/* Add $wp_rewrite->front to the trail. */
$this->do_rewrite_front_items();
/* Map the rewrite tags. */
$this->map_rewrite_tags( $post_id, get_option( 'permalink_structure' ) );
}
/* If the post type has rewrite rules. */
elseif ( false !== $post_type_object->rewrite ) {
/* If 'with_front' is true, add $wp_rewrite->front to the trail. */
if ( $post_type_object->rewrite['with_front'] )
$this->do_rewrite_front_items();
/* If there's a path, check for parents. */
if ( !empty( $post_type_object->rewrite['slug'] ) )
$this->do_path_parents( $post_type_object->rewrite['slug'] );
}
/* If there's an archive page, add it to the trail. */
if ( !empty( $post_type_object->has_archive ) ) {
/* Add support for a non-standard label of 'archive_title' (special use case). */
$label = !empty( $post_type_object->labels->archive_title ) ? $post_type_object->labels->archive_title : $post_type_object->labels->name;
$this->items[] = '<a href="' . get_post_type_archive_link( $post_type ) . '">' . $label . '</a>';
}
}
/**
* Gets post types by slug. This is needed because the get_post_types() function doesn't exactly
* match the 'has_archive' argument when it's set as a string instead of a boolean.
*
* @since 0.6.0
* @access public
* @param int $slug The post type archive slug to search for.
* @return void
*/
public function get_post_types_by_slug( $slug ) {
$return = array();
$post_types = get_post_types( array(), 'objects' );
foreach ( $post_types as $type ) {
if ( $slug === $type->has_archive || ( true === $type->has_archive && $slug === $type->rewrite['slug'] ) )
$return[] = $type;
}
return $return;
}
/**
* Adds the items to the trail items array for taxonomy term archives.
*
* @since 0.6.0
* @access public
* @global object $wp_rewrite
* @return void
*/
public function do_term_archive_items() {
global $wp_rewrite;
/* Get some taxonomy and term variables. */
$term = get_queried_object();
$taxonomy = get_taxonomy( $term->taxonomy );
/* If there are rewrite rules for the taxonomy. */
if ( false !== $taxonomy->rewrite ) {
/* If 'with_front' is true, dd $wp_rewrite->front to the trail. */
if ( $taxonomy->rewrite['with_front'] && $wp_rewrite->front )
$this->do_rewrite_front_items();
/* Get parent pages by path if they exist. */
$this->do_path_parents( $taxonomy->rewrite['slug'] );
/* Add post type archive if its 'has_archive' matches the taxonomy rewrite 'slug'. */
if ( $taxonomy->rewrite['slug'] ) {
$slug = trim( $taxonomy->rewrite['slug'], '/' );
/**
* Deals with the situation if the slug has a '/' between multiple strings. For
* example, "movies/genres" where "movies" is the post type archive.
*/
$matches = explode( '/', $slug );
/* If matches are found for the path. */
if ( isset( $matches ) ) {
/* Reverse the array of matches to search for posts in the proper order. */
$matches = array_reverse( $matches );
/* Loop through each of the path matches. */
foreach ( $matches as $match ) {
/* If a match is found. */
$slug = $match;
/* Get public post types that match the rewrite slug. */
$post_types = $this->get_post_types_by_slug( $match );
if ( !empty( $post_types ) ) {
$post_type_object = $post_types[0];
/* Add support for a non-standard label of 'archive_title' (special use case). */
$label = !empty( $post_type_object->labels->archive_title ) ? $post_type_object->labels->archive_title : $post_type_object->labels->name;
/* Add the post type archive link to the trail. */
$this->items[] = '<a href="' . get_post_type_archive_link( $post_type_object->name ) . '" title="' . esc_attr( $label ) . '">' . $label . '</a>';
/* Break out of the loop. */
break;
}
}
}
}
}
/* If the taxonomy is hierarchical, list its parent terms. */
if ( is_taxonomy_hierarchical( $term->taxonomy ) && $term->parent )
$this->do_term_parents( $term->parent, $term->taxonomy );
/* Add the term name to the trail end. */
if ( is_paged() )
$this->items[] = '<a href="' . esc_url( get_term_link( $term, $term->taxonomy ) ) . '" title="' . esc_attr( single_term_title( '', false ) ) . '">' . single_term_title( '', false ) . '</a>';
elseif ( true === $this->args['show_title'] )
$this->items[] = single_term_title( '', false );
}
/**
* Adds the items to the trail items array for post type archives.
*
* @since 0.6.0
* @access public
* @return void
*/
public function do_post_type_archive_items() {
/* Get the post type object. */
$post_type_object = get_post_type_object( get_query_var( 'post_type' ) );
if ( false !== $post_type_object->rewrite ) {
/* If 'with_front' is true, add $wp_rewrite->front to the trail. */
if ( $post_type_object->rewrite['with_front'] )
$this->do_rewrite_front_items();
/* If there's a rewrite slug, check for parents. */
if ( !empty( $post_type_object->rewrite['slug'] ) )
$this->do_path_parents( $post_type_object->rewrite['slug'] );
}
/* Add the post type [plural] name to the trail end. */
if ( is_paged() )
$this->items[] = '<a href="' . esc_url( get_post_type_archive_link( $post_type_object->name ) ) . '" title="' . esc_attr( post_type_archive_title( '', false ) ) . '">' . post_type_archive_title( '', false ) . '</a>';
elseif ( true === $this->args['show_title'] )
$this->items[] = post_type_archive_title( '', false );
}
/**
* Adds the items to the trail items array for user (author) archives.
*
* @since 0.6.0
* @access public
* @global object $wp_rewrite
* @return void
*/
public function do_user_archive_items() {
global $wp_rewrite;
/* Add $wp_rewrite->front to the trail. */
$this->do_rewrite_front_items();
/* Get the user ID. */
$user_id = get_query_var( 'author' );
/* If $author_base exists, check for parent pages. */
if ( !empty( $wp_rewrite->author_base ) )
$this->do_path_parents( $wp_rewrite->author_base );
/* Add the author's display name to the trail end. */
if ( is_paged() )
$this->items[] = '<a href="'. esc_url( get_author_posts_url( $user_id ) ) . '" title="' . esc_attr( get_the_author_meta( 'display_name', $user_id ) ) . '">' . get_the_author_meta( 'display_name', $user_id ) . '</a>';
elseif ( true === $this->args['show_title'] )
$this->items[] = get_the_author_meta( 'display_name', $user_id );
}
/**
* Adds the items to the trail items array for minute + hour archives.
*
* @since 0.6.0
* @access public
* @return void
*/
public function do_minute_hour_archive_items() {
/* Add $wp_rewrite->front to the trail. */
$this->do_rewrite_front_items();
/* Add the minute + hour item. */
if ( true === $this->args['show_title'] )
$this->items[] = get_the_time( $this->args['labels']['archive_minute_hour'] );
}
/**
* Adds the items to the trail items array for minute archives.
*
* @since 0.6.0
* @access public
* @return void
*/
public function do_minute_archive_items() {
/* Add $wp_rewrite->front to the trail. */
$this->do_rewrite_front_items();
/* Add the minute item. */
if ( true === $this->args['show_title'] )
$this->items[] = sprintf( $this->args['labels']['archive_minute'], date_i18n( 'i', get_the_time( 'U' ) ) );
}
/**
* Adds the items to the trail items array for hour archives.
*
* @since 0.6.0
* @access public
* @return void
*/
public function do_hour_archive_items() {
/* Add $wp_rewrite->front to the trail. */
$this->do_rewrite_front_items();
/* Add the hour item. */
if ( true === $this->args['show_title'] )
$this->items[] = get_the_time( $this->args['labels']['archive_hour'] );
}
/**
* Adds the items to the trail items array for day archives.
*
* @since 0.6.0
* @access public
* @return void
*/
public function do_day_archive_items() {
/* Add $wp_rewrite->front to the trail. */
$this->do_rewrite_front_items();
/* Get year, month, and day. */
$year = get_the_time( $this->args['labels']['archive_year'] );
$month = get_the_time( $this->args['labels']['archive_month'] );
$day = get_the_time( $this->args['labels']['archive_day'] );
/* Add the year and month items. */
$this->items[] = '<a href="' . get_year_link( get_the_time( 'Y' ) ) . '" title="' . esc_attr( $year ) . '">' . $year . '</a>';
$this->items[] = '<a href="' . get_month_link( get_the_time( 'Y' ), get_the_time( 'm' ) ) . '" title="' . esc_attr( $month ) . '">' . $month . '</a>';
/* Add the day item. */
if ( is_paged() )
$this->items[] = '<a href="' . get_day_link( get_the_time( 'Y' ), get_the_time( 'm' ), get_the_time( 'd' ) ) . '" title="' . esc_attr( $day ) . '">' . $day . '</a>';
elseif ( true === $this->args['show_title'] )
$this->items[] = $day;
}
/**
* Adds the items to the trail items array for week archives.
*
* @since 0.6.0
* @access public
* @return void
*/
public function do_week_archive_items() {
/* Add $wp_rewrite->front to the trail. */
$this->do_rewrite_front_items();
/* Get the year and week. */
$year = get_the_time( $this->args['labels']['archive_year'] );
$week = sprintf( $this->args['labels']['archive_week'], date_i18n( 'W', get_the_time( 'U' ) ) );
/* Add the year item. */
$this->items[] = '<a href="' . get_year_link( get_the_time( 'Y' ) ) . '" title="' . esc_attr( $year ) . '">' . $year . '</a>';
/* Add the week item. */
if ( is_paged() )
$this->items[] = get_archives_link( add_query_arg( array( 'm' => get_the_time( 'Y' ), 'w' => get_the_time( 'W' ) ), home_url() ), $week, false );
elseif ( true === $this->args['show_title'] )
$this->items[] = $week;
}
/**
* Adds the items to the trail items array for month archives.
*
* @since 0.6.0
* @access public
* @return void
*/
public function do_month_archive_items() {
/* Add $wp_rewrite->front to the trail. */
$this->do_rewrite_front_items();
/* Get the year and month. */
$year = get_the_time( $this->args['labels']['archive_year'] );
$month = get_the_time( $this->args['labels']['archive_month'] );
/* Add the year item. */
$this->items[] = '<a href="' . get_year_link( get_the_time( 'Y' ) ) . '" title="' . esc_attr( $year ) . '">' . $year . '</a>';
/* Add the month item. */
if ( is_paged() )
$this->items[] = '<a href="' . get_month_link( get_the_time( 'Y' ), get_the_time( 'm' ) ) . '" title="' . esc_attr( $month ) . '">' . $month . '</a>';
elseif ( true === $this->args['show_title'] )
$this->items[] = $month;
}
/**
* Adds the items to the trail items array for year archives.
*
* @since 0.6.0
* @access public
* @return void
*/
public function do_year_archive_items() {
/* Add $wp_rewrite->front to the trail. */
$this->do_rewrite_front_items();
/* Get the year. */
$year = get_the_time( $this->args['labels']['archive_year'] );
/* Add the year item. */
if ( is_paged() )
$this->items[] = '<a href="' . get_year_link( get_the_time( 'Y' ) ) . '" title="' . esc_attr( $year ) . '">' . $year . '</a>';
elseif ( true === $this->args['show_title'] )
$this->items[] = $year;
}
/**
* Adds the items to the trail items array for archives that don't have a more specific method
* defined in this class.
*
* @since 0.6.0
* @access public
* @return void
*/
public function do_default_archive_items() {
/* If this is a date-/time-based archive, add $wp_rewrite->front to the trail. */
if ( is_date() || is_time() )
$this->do_rewrite_front_items();
if ( true === $this->args['show_title'] )
$this->items[] = $this->args['labels']['archives'];
}
/**
* Adds the items to the trail items array for search results.
*
* @since 0.6.0
* @access public
* @return void
*/
public function do_search_items() {
if ( is_paged() )
$this->items[] = '<a href="' . get_search_link() . '" title="' . esc_attr( sprintf( $this->args['labels']['search'], get_search_query() ) ) . '">' . sprintf( $this->args['labels']['search'], get_search_query() ) . '</a>';
elseif ( true === $this->args['show_title'] )
$this->items[] = sprintf( $this->args['labels']['search'], get_search_query() );
}
/**
* Adds the items to the trail items array for 404 pages.
*
* @since 0.6.0
* @access public
* @return void
*/
public function do_404_items() {
if ( true === $this->args['show_title'] )
$this->items[] = $this->args['labels']['error_404'];
}
/**
* Get parent posts by path. Currently, this method only supports getting parents of the 'page'
* post type. The goal of this function is to create a clear path back to home given what would
* normally be a "ghost" directory. If any page matches the given path, it'll be added.
*
* @since 0.6.0
* @access public
* @param string $path The path (slug) to search for posts by.
* @return void
*/
function do_path_parents( $path ) {
/* Trim '/' off $path in case we just got a simple '/' instead of a real path. */
$path = trim( $path, '/' );
/* If there's no path, return. */
if ( empty( $path ) )
return;
/* Get parent post by the path. */
$post = get_page_by_path( $path );
if ( !empty( $post ) ) {
$this->do_post_parents( $post->ID );
}
elseif ( is_null( $post ) ) {
/* Separate post names into separate paths by '/'. */
$path = trim( $path, '/' );
preg_match_all( "/\/.*?\z/", $path, $matches );
/* If matches are found for the path. */
if ( isset( $matches ) ) {
/* Reverse the array of matches to search for posts in the proper order. */
$matches = array_reverse( $matches );
/* Loop through each of the path matches. */
foreach ( $matches as $match ) {
/* If a match is found. */
if ( isset( $match[0] ) ) {
/* Get the parent post by the given path. */
$path = str_replace( $match[0], '', $path );
$post = get_page_by_path( trim( $path, '/' ) );
/* If a parent post is found, set the $post_id and break out of the loop. */
if ( !empty( $post ) && 0 < $post->ID ) {
$this->do_post_parents( $post->ID );
break;
}
}
}
}
}
}
/**
* Searches for term parents of hierarchical taxonomies. This function is similar to the WordPress
* function get_category_parents() but handles any type of taxonomy.
*
* @since 0.6.0
* @param int $term_id ID of the term to get the parents of.
* @param string $taxonomy Name of the taxonomy for the given term.
* @return void
*/
function do_term_parents( $term_id, $taxonomy ) {
/* Set up some default arrays. */
$parents = array();
/* While there is a parent ID, add the parent term link to the $parents array. */
while ( $term_id ) {
/* Get the parent term. */
$term = get_term( $term_id, $taxonomy );
/* Add the formatted term link to the array of parent terms. */
$parents[] = '<a href="' . get_term_link( $term, $taxonomy ) . '" title="' . esc_attr( $term->name ) . '">' . $term->name . '</a>';
/* Set the parent term's parent as the parent ID. */
$term_id = $term->parent;
}
/* If we have parent terms, reverse the array to put them in the proper order for the trail. */
if ( !empty( $parents ) )
$this->items = array_merge( $this->items, $parents );
}
/**
* Turns %tag% from permalink structures into usable links for the breadcrumb trail. This feels kind of
* hackish for now because we're checking for specific %tag% examples and only doing it for the 'post'
* post type. In the future, maybe it'll handle a wider variety of possibilities, especially for custom post
* types.
*
* @since 0.6.0
* @access public
* @param int $post_id ID of the post whose parents we want.