FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
wordpress-azure/wp-includes/category-template.php at master · cmdel/wordpress-azure · GitHub
cmdel
/
wordpress-azure
Public
forked from
azureappserviceoss/wordpress-azure
Notifications
You must be signed in to change notification settings
Fork
0
Star
0
Code
Pull requests
0
Actions
Projects
Wiki
Security and quality
0
Insights
Additional navigation options
Code
Pull requests
Actions
Projects
Wiki
Security and quality
Insights
Expand file tree
Breadcrumbs
wordpress-azure
/
wp-includes
/
category-template.php
Copy path
More file actions
More file actions
Latest commit
History
History
History
1326 lines (1189 loc) · 47.4 KB
Breadcrumbs
wordpress-azure
/
wp-includes
/
category-template.php
Copy path
File metadata and controls
1326 lines (1189 loc) · 47.4 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
/**
* Taxonomy API: Core category-specific template tags
*
* @package WordPress
* @subpackage Template
* @since 1.2.0
*/
/**
* Retrieve category link URL.
*
* @since 1.0.0
* @see get_term_link()
*
* @param int|object $category Category ID or object.
* @return string Link on success, empty string if category does not exist.
*/
function
get_category_link
(
$
category
) {
if
( !
is_object
(
$
category
) )
$
category
= (
int
)
$
category
;
$
category
=
get_term_link
(
$
category
,
'
category
'
);
if
(
is_wp_error
(
$
category
) )
return
''
;
return
$
category
;
}
/**
* Retrieve category parents with separator.
*
* @since 1.2.0
*
* @param int $id Category ID.
* @param bool $link Optional, default is false. Whether to format with link.
* @param string $separator Optional, default is '/'. How to separate categories.
* @param bool $nicename Optional, default is false. Whether to use nice name for display.
* @param array $visited Optional. Already linked to categories to prevent duplicates.
* @return string|WP_Error A list of category parents on success, WP_Error on failure.
*/
function
get_category_parents
(
$
id
,
$
link
=
false
,
$
separator
=
'
/
'
,
$
nicename
=
false
,
$
visited
=
array
() ) {
$
chain
=
''
;
$
parent
=
get_term
(
$
id
,
'
category
'
);
if
(
is_wp_error
(
$
parent
) )
return
$
parent
;
if
(
$
nicename
)
$
name
=
$
parent
->
slug
;
else
$
name
=
$
parent
->
name
;
if
(
$
parent
->
parent
&& (
$
parent
->
parent
!=
$
parent
->
term_id
) && !
in_array
(
$
parent
->
parent
,
$
visited
) ) {
$
visited
[] =
$
parent
->
parent
;
$
chain
.=
get_category_parents
(
$
parent
->
parent
,
$
link
,
$
separator
,
$
nicename
,
$
visited
);
}
if
(
$
link
)
$
chain
.=
'
<a href="
'
.
esc_url
(
get_category_link
(
$
parent
->
term_id
) ) .
'
">
'
.
$
name
.
'
</a>
'
.
$
separator
;
else
$
chain
.=
$
name
.
$
separator
;
return
$
chain
;
}
/**
* Retrieve post categories.
*
* This tag may be used outside The Loop by passing a post id as the parameter.
*
* Note: This function only returns results from the default "category" taxonomy.
* For custom taxonomies use get_the_terms().
*
* @since 0.71
*
* @param int $id Optional, default to current post ID. The post ID.
* @return array Array of WP_Term objects, one for each category assigned to the post.
*/
function
get_the_category
(
$
id
=
false
) {
$
categories
=
get_the_terms
(
$
id
,
'
category
'
);
if
( !
$
categories
||
is_wp_error
(
$
categories
) )
$
categories
=
array
();
$
categories
=
array_values
(
$
categories
);
foreach
(
array_keys
(
$
categories
)
as
$
key
) {
_make_cat_compat
(
$
categories
[
$
key
] );
}
/**
* Filters the array of categories to return for a post.
*
* @since 3.1.0
* @since 4.4.0 Added `$id` parameter.
*
* @param array $categories An array of categories to return for the post.
* @param int $id ID of the post.
*/
return
apply_filters
(
'
get_the_categories
'
,
$
categories
,
$
id
);
}
/**
* Retrieve category name based on category ID.
*
* @since 0.71
*
* @param int $cat_ID Category ID.
* @return string|WP_Error Category name on success, WP_Error on failure.
*/
function
get_the_category_by_ID
(
$
cat_ID
) {
$
cat_ID
= (
int
)
$
cat_ID
;
$
category
=
get_term
(
$
cat_ID
,
'
category
'
);
if
(
is_wp_error
(
$
category
) )
return
$
category
;
return
(
$
category
) ?
$
category
->
name
:
''
;
}
/**
* Retrieve category list in either HTML list or custom format.
*
* @since 1.5.1
*
* @global WP_Rewrite $wp_rewrite
*
* @param string $separator Optional, default is empty string. Separator for between the categories.
* @param string $parents Optional. How to display the parents.
* @param int $post_id Optional. Post ID to retrieve categories.
* @return string
*/
function
get_the_category_list
(
$
separator
=
''
,
$
parents
=
''
,
$
post_id
=
false
) {
global
$
wp_rewrite
;
if
( !
is_object_in_taxonomy
(
get_post_type
(
$
post_id
),
'
category
'
) ) {
/** This filter is documented in wp-includes/category-template.php */
return
apply_filters
(
'
the_category
'
,
''
,
$
separator
,
$
parents
);
}
/**
* Filters the categories before building the category list.
*
* @since 4.4.0
*
* @param array $categories An array of the post's categories.
* @param int|bool $post_id ID of the post we're retrieving categories for. When `false`, we assume the
* current post in the loop.
*/
$
categories
=
apply_filters
(
'
the_category_list
'
,
get_the_category
(
$
post_id
),
$
post_id
);
if
(
empty
(
$
categories
) ) {
/** This filter is documented in wp-includes/category-template.php */
return
apply_filters
(
'
the_category
'
,
__
(
'
Uncategorized
'
),
$
separator
,
$
parents
);
}
$
rel
= (
is_object
(
$
wp_rewrite
) &&
$
wp_rewrite
->
using_permalinks
() ) ?
'
rel="category tag"
'
:
'
rel="category"
'
;
$
thelist
=
''
;
if
(
''
==
$
separator
) {
$
thelist
.=
'
<ul class="post-categories">
'
;
foreach
(
$
categories
as
$
category
) {
$
thelist
.=
"\n\t
<li>
"
;
switch
(
strtolower
(
$
parents
) ) {
case
'
multiple
'
:
if
(
$
category
->
parent
)
$
thelist
.=
get_category_parents
(
$
category
->
parent
,
true
,
$
separator
);
$
thelist
.=
'
<a href="
'
.
esc_url
(
get_category_link
(
$
category
->
term_id
) ) .
'
"
'
.
$
rel
.
'
>
'
.
$
category
->
name
.
'
</a></li>
'
;
break
;
case
'
single
'
:
$
thelist
.=
'
<a href="
'
.
esc_url
(
get_category_link
(
$
category
->
term_id
) ) .
'
"
'
.
$
rel
.
'
>
'
;
if
(
$
category
->
parent
)
$
thelist
.=
get_category_parents
(
$
category
->
parent
,
false
,
$
separator
);
$
thelist
.=
$
category
->
name
.
'
</a></li>
'
;
break
;
case
''
:
default
:
$
thelist
.=
'
<a href="
'
.
esc_url
(
get_category_link
(
$
category
->
term_id
) ) .
'
"
'
.
$
rel
.
'
>
'
.
$
category
->
name
.
'
</a></li>
'
;
}
}
$
thelist
.=
'
</ul>
'
;
}
else
{
$
i
=
0
;
foreach
(
$
categories
as
$
category
) {
if
(
0
<
$
i
)
$
thelist
.=
$
separator
;
switch
(
strtolower
(
$
parents
) ) {
case
'
multiple
'
:
if
(
$
category
->
parent
)
$
thelist
.=
get_category_parents
(
$
category
->
parent
,
true
,
$
separator
);
$
thelist
.=
'
<a href="
'
.
esc_url
(
get_category_link
(
$
category
->
term_id
) ) .
'
"
'
.
$
rel
.
'
>
'
.
$
category
->
name
.
'
</a>
'
;
break
;
case
'
single
'
:
$
thelist
.=
'
<a href="
'
.
esc_url
(
get_category_link
(
$
category
->
term_id
) ) .
'
"
'
.
$
rel
.
'
>
'
;
if
(
$
category
->
parent
)
$
thelist
.=
get_category_parents
(
$
category
->
parent
,
false
,
$
separator
);
$
thelist
.=
"
$
category
->
name
</a>
"
;
break
;
case
''
:
default
:
$
thelist
.=
'
<a href="
'
.
esc_url
(
get_category_link
(
$
category
->
term_id
) ) .
'
"
'
.
$
rel
.
'
>
'
.
$
category
->
name
.
'
</a>
'
;
}
++
$
i
;
}
}
/**
* Filters the category or list of categories.
*
* @since 1.2.0
*
* @param array $thelist List of categories for the current post.
* @param string $separator Separator used between the categories.
* @param string $parents How to display the category parents. Accepts 'multiple',
* 'single', or empty.
*/
return
apply_filters
(
'
the_category
'
,
$
thelist
,
$
separator
,
$
parents
);
}
/**
* Check if the current post is within any of the given categories.
*
* The given categories are checked against the post's categories' term_ids, names and slugs.
* Categories given as integers will only be checked against the post's categories' term_ids.
*
* Prior to v2.5 of WordPress, category names were not supported.
* Prior to v2.7, category slugs were not supported.
* Prior to v2.7, only one category could be compared: in_category( $single_category ).
* Prior to v2.7, this function could only be used in the WordPress Loop.
* As of 2.7, the function can be used anywhere if it is provided a post ID or post object.
*
* @since 1.2.0
*
* @param int|string|array $category Category ID, name or slug, or array of said.
* @param int|object $post Optional. Post to check instead of the current post. (since 2.7.0)
* @return bool True if the current post is in any of the given categories.
*/
function
in_category
(
$
category
,
$
post
=
null
) {
if
(
empty
(
$
category
) )
return
false
;
return
has_category
(
$
category
,
$
post
);
}
/**
* Display the category list for the post.
*
* @since 0.71
*
* @param string $separator Optional, default is empty string. Separator for between the categories.
* @param string $parents Optional. How to display the parents.
* @param int $post_id Optional. Post ID to retrieve categories.
*/
function
the_category
(
$
separator
=
''
,
$
parents
=
''
,
$
post_id
=
false
) {
echo
get_the_category_list
(
$
separator
,
$
parents
,
$
post_id
);
}
/**
* Retrieve category description.
*
* @since 1.0.0
*
* @param int $category Optional. Category ID. Will use global category ID by default.
* @return string Category description, available.
*/
function
category_description
(
$
category
=
0
) {
return
term_description
(
$
category
,
'
category
'
);
}
/**
* Display or retrieve the HTML dropdown list of categories.
*
* The 'hierarchical' argument, which is disabled by default, will override the
* depth argument, unless it is true. When the argument is false, it will
* display all of the categories. When it is enabled it will use the value in
* the 'depth' argument.
*
* @since 2.1.0
* @since 4.2.0 Introduced the `value_field` argument.
* @since 4.6.0 Introduced the `required` argument.
*
* @param string|array $args {
* Optional. Array or string of arguments to generate a categories drop-down element.
*
* @type string $show_option_all Text to display for showing all categories. Default empty.
* @type string $show_option_none Text to display for showing no categories. Default empty.
* @type string $option_none_value Value to use when no category is selected. Default empty.
* @type string $orderby Which column to use for ordering categories. See get_terms() for a list
* of accepted values. Default 'id' (term_id).
* @type string $order Whether to order terms in ascending or descending order. Accepts 'ASC'
* or 'DESC'. Default 'ASC'.
* @type bool $pad_counts See get_terms() for an argument description. Default false.
* @type bool|int $show_count Whether to include post counts. Accepts 0, 1, or their bool equivalents.
* Default 0.
* @type bool|int $hide_empty Whether to hide categories that don't have any posts. Accepts 0, 1, or
* their bool equivalents. Default 1.
* @type int $child_of Term ID to retrieve child terms of. See get_terms(). Default 0.
* @type array|string $exclude Array or comma/space-separated string of term ids to exclude.
* If `$include` is non-empty, `$exclude` is ignored. Default empty array.
* @type bool|int $echo Whether to echo or return the generated markup. Accepts 0, 1, or their
* bool equivalents. Default 1.
* @type bool|int $hierarchical Whether to traverse the taxonomy hierarchy. Accepts 0, 1, or their bool
* equivalents. Default 0.
* @type int $depth Maximum depth. Default 0.
* @type int $tab_index Tab index for the select element. Default 0 (no tabindex).
* @type string $name Value for the 'name' attribute of the select element. Default 'cat'.
* @type string $id Value for the 'id' attribute of the select element. Defaults to the value
* of `$name`.
* @type string $class Value for the 'class' attribute of the select element. Default 'postform'.
* @type int|string $selected Value of the option that should be selected. Default 0.
* @type string $value_field Term field that should be used to populate the 'value' attribute
* of the option elements. Accepts any valid term field: 'term_id', 'name',
* 'slug', 'term_group', 'term_taxonomy_id', 'taxonomy', 'description',
* 'parent', 'count'. Default 'term_id'.
* @type string|array $taxonomy Name of the category or categories to retrieve. Default 'category'.
* @type bool $hide_if_empty True to skip generating markup if no categories are found.
* Default false (create select element even if no categories are found).
* @type bool $required Whether the `<select>` element should have the HTML5 'required' attribute.
* Default false.
* }
* @return string HTML content only if 'echo' argument is 0.
*/
function
wp_dropdown_categories
(
$
args
=
''
) {
$
defaults
=
array
(
'
show_option_all
'
=>
''
,
'
show_option_none
'
=>
''
,
'
orderby
'
=>
'
id
'
,
'
order
'
=>
'
ASC
'
,
'
show_count
'
=>
0
,
'
hide_empty
'
=>
1
,
'
child_of
'
=>
0
,
'
exclude
'
=>
''
,
'
echo
'
=>
1
,
'
selected
'
=>
0
,
'
hierarchical
'
=>
0
,
'
name
'
=>
'
cat
'
,
'
id
'
=>
''
,
'
class
'
=>
'
postform
'
,
'
depth
'
=>
0
,
'
tab_index
'
=>
0
,
'
taxonomy
'
=>
'
category
'
,
'
hide_if_empty
'
=>
false
,
'
option_none_value
'
=> -
1
,
'
value_field
'
=>
'
term_id
'
,
'
required
'
=>
false
,
);
$
defaults
[
'
selected
'
] = (
is_category
() ) ?
get_query_var
(
'
cat
'
) :
0
;
// Back compat.
if
(
isset
(
$
args
[
'
type
'
] ) &&
'
link
'
==
$
args
[
'
type
'
] ) {
/* translators: 1: "type => link", 2: "taxonomy => link_category" alternative */
_deprecated_argument
(
__FUNCTION__
,
'
3.0.0
'
,
sprintf
(
__
(
'
%1$s is deprecated. Use %2$s instead.
'
),
'
<code>type => link</code>
'
,
'
<code>taxonomy => link_category</code>
'
)
);
$
args
[
'
taxonomy
'
] =
'
link_category
'
;
}
$
r
=
wp_parse_args
(
$
args
,
$
defaults
);
$
option_none_value
=
$
r
[
'
option_none_value
'
];
if
( !
isset
(
$
r
[
'
pad_counts
'
] ) &&
$
r
[
'
show_count
'
] &&
$
r
[
'
hierarchical
'
] ) {
$
r
[
'
pad_counts
'
] =
true
;
}
$
tab_index
=
$
r
[
'
tab_index
'
];
$
tab_index_attribute
=
''
;
if
( (
int
)
$
tab_index
>
0
) {
$
tab_index_attribute
=
"
tabindex=
\"
$
tab_index
\""
;
}
// Avoid clashes with the 'name' param of get_terms().
$
get_terms_args
=
$
r
;
unset(
$
get_terms_args
[
'
name
'
] );
$
categories
=
get_terms
(
$
r
[
'
taxonomy
'
],
$
get_terms_args
);
$
name
=
esc_attr
(
$
r
[
'
name
'
] );
$
class
=
esc_attr
(
$
r
[
'
class
'
] );
$
id
=
$
r
[
'
id
'
] ?
esc_attr
(
$
r
[
'
id
'
] ) :
$
name
;
$
required
=
$
r
[
'
required
'
] ?
'
required
'
:
''
;
if
( !
$
r
[
'
hide_if_empty
'
] || !
empty
(
$
categories
) ) {
$
output
=
"
<select
$
required
name='
$
name
' id='
$
id
' class='
$
class
'
$
tab_index_attribute
>
\n"
;
}
else
{
$
output
=
''
;
}
if
(
empty
(
$
categories
) && !
$
r
[
'
hide_if_empty
'
] && !
empty
(
$
r
[
'
show_option_none
'
] ) ) {
/**
* Filters a taxonomy drop-down display element.
*
* A variety of taxonomy drop-down display elements can be modified
* just prior to display via this filter. Filterable arguments include
* 'show_option_none', 'show_option_all', and various forms of the
* term name.
*
* @since 1.2.0
*
* @see wp_dropdown_categories()
*
* @param string $element Taxonomy element to list.
*/
$
show_option_none
=
apply_filters
(
'
list_cats
'
,
$
r
[
'
show_option_none
'
] );
$
output
.=
"\t
<option value='
"
.
esc_attr
(
$
option_none_value
) .
"
' selected='selected'>
$
show_option_none
</option>
\n"
;
}
if
( !
empty
(
$
categories
) ) {
if
(
$
r
[
'
show_option_all
'
] ) {
/** This filter is documented in wp-includes/category-template.php */
$
show_option_all
=
apply_filters
(
'
list_cats
'
,
$
r
[
'
show_option_all
'
] );
$
selected
= (
'
0
'
===
strval
(
$
r
[
'
selected
'
]) ) ?
"
selected='selected'
"
:
''
;
$
output
.=
"\t
<option value='0'
$
selected
>
$
show_option_all
</option>
\n"
;
}
if
(
$
r
[
'
show_option_none
'
] ) {
/** This filter is documented in wp-includes/category-template.php */
$
show_option_none
=
apply_filters
(
'
list_cats
'
,
$
r
[
'
show_option_none
'
] );
$
selected
=
selected
(
$
option_none_value
,
$
r
[
'
selected
'
],
false
);
$
output
.=
"\t
<option value='
"
.
esc_attr
(
$
option_none_value
) .
"
'
$
selected
>
$
show_option_none
</option>
\n"
;
}
if
(
$
r
[
'
hierarchical
'
] ) {
$
depth
=
$
r
[
'
depth
'
];
// Walk the full depth.
}
else
{
$
depth
= -
1
;
// Flat.
}
$
output
.=
walk_category_dropdown_tree
(
$
categories
,
$
depth
,
$
r
);
}
if
( !
$
r
[
'
hide_if_empty
'
] || !
empty
(
$
categories
) ) {
$
output
.=
"
</select>
\n"
;
}
/**
* Filters the taxonomy drop-down output.
*
* @since 2.1.0
*
* @param string $output HTML output.
* @param array $r Arguments used to build the drop-down.
*/
$
output
=
apply_filters
(
'
wp_dropdown_cats
'
,
$
output
,
$
r
);
if
(
$
r
[
'
echo
'
] ) {
echo
$
output
;
}
return
$
output
;
}
/**
* Display or retrieve the HTML list of categories.
*
* @since 2.1.0
* @since 4.4.0 Introduced the `hide_title_if_empty` and `separator` arguments. The `current_category` argument was modified to
* optionally accept an array of values.
*
* @param string|array $args {
* Array of optional arguments.
*
* @type int $child_of Term ID to retrieve child terms of. See get_terms(). Default 0.
* @type int|array $current_category ID of category, or array of IDs of categories, that should get the
* 'current-cat' class. Default 0.
* @type int $depth Category depth. Used for tab indentation. Default 0.
* @type bool|int $echo True to echo markup, false to return it. Default 1.
* @type array|string $exclude Array or comma/space-separated string of term IDs to exclude.
* If `$hierarchical` is true, descendants of `$exclude` terms will also
* be excluded; see `$exclude_tree`. See get_terms().
* Default empty string.
* @type array|string $exclude_tree Array or comma/space-separated string of term IDs to exclude, along
* with their descendants. See get_terms(). Default empty string.
* @type string $feed Text to use for the feed link. Default 'Feed for all posts filed
* under [cat name]'.
* @type string $feed_image URL of an image to use for the feed link. Default empty string.
* @type string $feed_type Feed type. Used to build feed link. See get_term_feed_link().
* Default empty string (default feed).
* @type bool|int $hide_empty Whether to hide categories that don't have any posts attached to them.
* Default 1.
* @type bool $hide_title_if_empty Whether to hide the `$title_li` element if there are no terms in
* the list. Default false (title will always be shown).
* @type bool $hierarchical Whether to include terms that have non-empty descendants.
* See get_terms(). Default true.
* @type string $order Which direction to order categories. Accepts 'ASC' or 'DESC'.
* Default 'ASC'.
* @type string $orderby The column to use for ordering categories. Default 'ID'.
* @type string $separator Separator between links. Default '<br />'.
* @type bool|int $show_count Whether to show how many posts are in the category. Default 0.
* @type string $show_option_all Text to display for showing all categories. Default empty string.
* @type string $show_option_none Text to display for the 'no categories' option.
* Default 'No categories'.
* @type string $style The style used to display the categories list. If 'list', categories
* will be output as an unordered list. If left empty or another value,
* categories will be output separated by `<br>` tags. Default 'list'.
* @type string $taxonomy Taxonomy name. Default 'category'.
* @type string $title_li Text to use for the list title `<li>` element. Pass an empty string
* to disable. Default 'Categories'.
* @type bool|int $use_desc_for_title Whether to use the category description as the title attribute.
* Default 1.
* }
* @return false|string HTML content only if 'echo' argument is 0.
*/
function
wp_list_categories
(
$
args
=
''
) {
$
defaults
=
array
(
'
child_of
'
=>
0
,
'
current_category
'
=>
0
,
'
depth
'
=>
0
,
'
echo
'
=>
1
,
'
exclude
'
=>
''
,
'
exclude_tree
'
=>
''
,
'
feed
'
=>
''
,
'
feed_image
'
=>
''
,
'
feed_type
'
=>
''
,
'
hide_empty
'
=>
1
,
'
hide_title_if_empty
'
=>
false
,
'
hierarchical
'
=>
true
,
'
order
'
=>
'
ASC
'
,
'
orderby
'
=>
'
name
'
,
'
separator
'
=>
'
<br />
'
,
'
show_count
'
=>
0
,
'
show_option_all
'
=>
''
,
'
show_option_none
'
=>
__
(
'
No categories
'
),
'
style
'
=>
'
list
'
,
'
taxonomy
'
=>
'
category
'
,
'
title_li
'
=>
__
(
'
Categories
'
),
'
use_desc_for_title
'
=>
1
,
);
$
r
=
wp_parse_args
(
$
args
,
$
defaults
);
if
( !
isset
(
$
r
[
'
pad_counts
'
] ) &&
$
r
[
'
show_count
'
] &&
$
r
[
'
hierarchical
'
] )
$
r
[
'
pad_counts
'
] =
true
;
// Descendants of exclusions should be excluded too.
if
(
true
==
$
r
[
'
hierarchical
'
] ) {
$
exclude_tree
=
array
();
if
(
$
r
[
'
exclude_tree
'
] ) {
$
exclude_tree
=
array_merge
(
$
exclude_tree
,
wp_parse_id_list
(
$
r
[
'
exclude_tree
'
] ) );
}
if
(
$
r
[
'
exclude
'
] ) {
$
exclude_tree
=
array_merge
(
$
exclude_tree
,
wp_parse_id_list
(
$
r
[
'
exclude
'
] ) );
}
$
r
[
'
exclude_tree
'
] =
$
exclude_tree
;
$
r
[
'
exclude
'
] =
''
;
}
if
( !
isset
(
$
r
[
'
class
'
] ) )
$
r
[
'
class
'
] = (
'
category
'
==
$
r
[
'
taxonomy
'
] ) ?
'
categories
'
:
$
r
[
'
taxonomy
'
];
if
( !
taxonomy_exists
(
$
r
[
'
taxonomy
'
] ) ) {
return
false
;
}
$
show_option_all
=
$
r
[
'
show_option_all
'
];
$
show_option_none
=
$
r
[
'
show_option_none
'
];
$
categories
=
get_categories
(
$
r
);
$
output
=
''
;
if
(
$
r
[
'
title_li
'
] &&
'
list
'
==
$
r
[
'
style
'
] && ( !
empty
(
$
categories
) || !
$
r
[
'
hide_title_if_empty
'
] ) ) {
$
output
=
'
<li class="
'
.
esc_attr
(
$
r
[
'
class
'
] ) .
'
">
'
.
$
r
[
'
title_li
'
] .
'
<ul>
'
;
}
if
(
empty
(
$
categories
) ) {
if
( !
empty
(
$
show_option_none
) ) {
if
(
'
list
'
==
$
r
[
'
style
'
] ) {
$
output
.=
'
<li class="cat-item-none">
'
.
$
show_option_none
.
'
</li>
'
;
}
else
{
$
output
.=
$
show_option_none
;
}
}
}
else
{
if
( !
empty
(
$
show_option_all
) ) {
$
posts_page
=
''
;
// For taxonomies that belong only to custom post types, point to a valid archive.
$
taxonomy_object
=
get_taxonomy
(
$
r
[
'
taxonomy
'
] );
if
( !
in_array
(
'
post
'
,
$
taxonomy_object
->
object_type
) && !
in_array
(
'
page
'
,
$
taxonomy_object
->
object_type
) ) {
foreach
(
$
taxonomy_object
->
object_type
as
$
object_type
) {
$
_object_type
=
get_post_type_object
(
$
object_type
);
// Grab the first one.
if
( !
empty
(
$
_object_type
->
has_archive
) ) {
$
posts_page
=
get_post_type_archive_link
(
$
object_type
);
break
;
}
}
}
// Fallback for the 'All' link is the posts page.
if
( !
$
posts_page
) {
if
(
'
page
'
==
get_option
(
'
show_on_front
'
) &&
get_option
(
'
page_for_posts
'
) ) {
$
posts_page
=
get_permalink
(
get_option
(
'
page_for_posts
'
) );
}
else
{
$
posts_page
=
home_url
(
'
/
'
);
}
}
$
posts_page
=
esc_url
(
$
posts_page
);
if
(
'
list
'
==
$
r
[
'
style
'
] ) {
$
output
.=
"
<li class='cat-item-all'><a href='
$
posts_page
'>
$
show_option_all
</a></li>
"
;
}
else
{
$
output
.=
"
<a href='
$
posts_page
'>
$
show_option_all
</a>
"
;
}
}
if
(
empty
(
$
r
[
'
current_category
'
] ) && (
is_category
() ||
is_tax
() ||
is_tag
() ) ) {
$
current_term_object
=
get_queried_object
();
if
(
$
current_term_object
&&
$
r
[
'
taxonomy
'
] ===
$
current_term_object
->
taxonomy
) {
$
r
[
'
current_category
'
] =
get_queried_object_id
();
}
}
if
(
$
r
[
'
hierarchical
'
] ) {
$
depth
=
$
r
[
'
depth
'
];
}
else
{
$
depth
= -
1
;
// Flat.
}
$
output
.=
walk_category_tree
(
$
categories
,
$
depth
,
$
r
);
}
if
(
$
r
[
'
title_li
'
] &&
'
list
'
==
$
r
[
'
style
'
] && ( !
empty
(
$
categories
) || !
$
r
[
'
hide_title_if_empty
'
] ) ) {
$
output
.=
'
</ul></li>
'
;
}
/**
* Filters the HTML output of a taxonomy list.
*
* @since 2.1.0
*
* @param string $output HTML output.
* @param array $args An array of taxonomy-listing arguments.
*/
$
html
=
apply_filters
(
'
wp_list_categories
'
,
$
output
,
$
args
);
if
(
$
r
[
'
echo
'
] ) {
echo
$
html
;
}
else
{
return
$
html
;
}
}
/**
* Display tag cloud.
*
* The text size is set by the 'smallest' and 'largest' arguments, which will
* use the 'unit' argument value for the CSS text size unit. The 'format'
* argument can be 'flat' (default), 'list', or 'array'. The flat value for the
* 'format' argument will separate tags with spaces. The list value for the
* 'format' argument will format the tags in a UL HTML list. The array value for
* the 'format' argument will return in PHP array type format.
*
* The 'orderby' argument will accept 'name' or 'count' and defaults to 'name'.
* The 'order' is the direction to sort, defaults to 'ASC' and can be 'DESC'.
*
* The 'number' argument is how many tags to return. By default, the limit will
* be to return the top 45 tags in the tag cloud list.
*
* The 'topic_count_text' argument is a nooped plural from _n_noop() to generate the
* text for the tooltip of the tag link.
*
* The 'topic_count_text_callback' argument is a function, which given the count
* of the posts with that tag returns a text for the tooltip of the tag link.
*
* The 'post_type' argument is used only when 'link' is set to 'edit'. It determines the post_type
* passed to edit.php for the popular tags edit links.
*
* The 'exclude' and 'include' arguments are used for the get_tags() function. Only one
* should be used, because only one will be used and the other ignored, if they are both set.
*
* @since 2.3.0
*
* @param array|string|null $args Optional. Override default arguments.
* @return void|array Generated tag cloud, only if no failures and 'array' is set for the 'format' argument.
* Otherwise, this function outputs the tag cloud.
*/
function
wp_tag_cloud
(
$
args
=
''
) {
$
defaults
=
array
(
'
smallest
'
=>
8
,
'
largest
'
=>
22
,
'
unit
'
=>
'
pt
'
,
'
number
'
=>
45
,
'
format
'
=>
'
flat
'
,
'
separator
'
=>
"\n"
,
'
orderby
'
=>
'
name
'
,
'
order
'
=>
'
ASC
'
,
'
exclude
'
=>
''
,
'
include
'
=>
''
,
'
link
'
=>
'
view
'
,
'
taxonomy
'
=>
'
post_tag
'
,
'
post_type
'
=>
''
,
'
echo
'
=>
true
);
$
args
=
wp_parse_args
(
$
args
,
$
defaults
);
$
tags
=
get_terms
(
$
args
[
'
taxonomy
'
],
array_merge
(
$
args
,
array
(
'
orderby
'
=>
'
count
'
,
'
order
'
=>
'
DESC
'
) ) );
// Always query top tags
if
(
empty
(
$
tags
) ||
is_wp_error
(
$
tags
) )
return
;
foreach
(
$
tags
as
$
key
=>
$
tag
) {
if
(
'
edit
'
==
$
args
[
'
link
'
] )
$
link
=
get_edit_term_link
(
$
tag
->
term_id
,
$
tag
->
taxonomy
,
$
args
[
'
post_type
'
] );
else
$
link
=
get_term_link
(
intval
(
$
tag
->
term_id
),
$
tag
->
taxonomy
);
if
(
is_wp_error
(
$
link
) )
return
;
$
tags
[
$
key
]->
link
=
$
link
;
$
tags
[
$
key
]->
id
=
$
tag
->
term_id
;
}
$
return
=
wp_generate_tag_cloud
(
$
tags
,
$
args
);
// Here's where those top tags get sorted according to $args
/**
* Filters the tag cloud output.
*
* @since 2.3.0
*
* @param string $return HTML output of the tag cloud.
* @param array $args An array of tag cloud arguments.
*/
$
return
=
apply_filters
(
'
wp_tag_cloud
'
,
$
return
,
$
args
);
if
(
'
array
'
==
$
args
[
'
format
'
] ||
empty
(
$
args
[
'
echo
'
]) )
return
$
return
;
echo
$
return
;
}
/**
* Default topic count scaling for tag links
*
* @param int $count number of posts with that tag
* @return int scaled count
*/
function
default_topic_count_scale
(
$
count
) {
return
round
(
log10
(
$
count
+
1
) *
100
);
}
/**
* Generates a tag cloud (heatmap) from provided data.
*
* @todo Complete functionality.
* @since 2.3.0
*
* @param array $tags List of tags.
* @param string|array $args {
* Optional. Array of string of arguments for generating a tag cloud.
*
* @type int $smallest Smallest font size used to display tags. Paired
* with the value of `$unit`, to determine CSS text
* size unit. Default 8 (pt).
* @type int $largest Largest font size used to display tags. Paired
* with the value of `$unit`, to determine CSS text
* size unit. Default 22 (pt).
* @type string $unit CSS text size unit to use with the `$smallest`
* and `$largest` values. Accepts any valid CSS text
* size unit. Default 'pt'.
* @type int $number The number of tags to return. Accepts any
* positive integer or zero to return all.
* Default 0.
* @type string $format Format to display the tag cloud in. Accepts 'flat'
* (tags separated with spaces), 'list' (tags displayed
* in an unordered list), or 'array' (returns an array).
* Default 'flat'.
* @type string $separator HTML or text to separate the tags. Default "\n" (newline).
* @type string $orderby Value to order tags by. Accepts 'name' or 'count'.
* Default 'name'. The {@see 'tag_cloud_sort'} filter
* can also affect how tags are sorted.
* @type string $order How to order the tags. Accepts 'ASC' (ascending),
* 'DESC' (descending), or 'RAND' (random). Default 'ASC'.
* @type int|bool $filter Whether to enable filtering of the final output
* via {@see 'wp_generate_tag_cloud'}. Default 1|true.
* @type string $topic_count_text Nooped plural text from _n_noop() to supply to
* tag tooltips. Default null.
* @type callable $topic_count_text_callback Callback used to generate nooped plural text for
* tag tooltips based on the count. Default null.
* @type callable $topic_count_scale_callback Callback used to determine the tag count scaling
* value. Default default_topic_count_scale().
* }
* @return string|array Tag cloud as a string or an array, depending on 'format' argument.
*/
function
wp_generate_tag_cloud
(
$
tags
,
$
args
=
''
) {
$
defaults
=
array
(
'
smallest
'
=>
8
,
'
largest
'
=>
22
,
'
unit
'
=>
'
pt
'
,
'
number
'
=>
0
,
'
format
'
=>
'
flat
'
,
'
separator
'
=>
"\n"
,
'
orderby
'
=>
'
name
'
,
'
order
'
=>
'
ASC
'
,
'
topic_count_text
'
=>
null
,
'
topic_count_text_callback
'
=>
null
,
'
topic_count_scale_callback
'
=>
'
default_topic_count_scale
'
,
'
filter
'
=>
1
,
);
$
args
=
wp_parse_args
(
$
args
,
$
defaults
);
$
return
= (
'
array
'
===
$
args
[
'
format
'
] ) ?
array
() :
''
;
if
(
empty
(
$
tags
) ) {
return
$
return
;
}
// Juggle topic count tooltips:
if
(
isset
(
$
args
[
'
topic_count_text
'
] ) ) {
// First look for nooped plural support via topic_count_text.
$
translate_nooped_plural
=
$
args
[
'
topic_count_text
'
];
}
elseif
( !
empty
(
$
args
[
'
topic_count_text_callback
'
] ) ) {
// Look for the alternative callback style. Ignore the previous default.
if
(
$
args
[
'
topic_count_text_callback
'
] ===
'
default_topic_count_text
'
) {
$
translate_nooped_plural
=
_n_noop
(
'
%s topic
'
,
'
%s topics
'
);
}
else
{
$
translate_nooped_plural
=
false
;
}
}
elseif
(
isset
(
$
args
[
'
single_text
'
] ) &&
isset
(
$
args
[
'
multiple_text
'
] ) ) {
// If no callback exists, look for the old-style single_text and multiple_text arguments.
$
translate_nooped_plural
=
_n_noop
(
$
args
[
'
single_text
'
],
$
args
[
'
multiple_text
'
] );
}
else
{
// This is the default for when no callback, plural, or argument is passed in.
$
translate_nooped_plural
=
_n_noop
(
'
%s topic
'
,
'
%s topics
'
);
}
/**
* Filters how the items in a tag cloud are sorted.
*
* @since 2.8.0
*
* @param array $tags Ordered array of terms.
* @param array $args An array of tag cloud arguments.
*/
$
tags_sorted
=
apply_filters
(
'
tag_cloud_sort
'
,
$
tags
,
$
args
);
if
(
empty
(
$
tags_sorted
) ) {
return
$
return
;
}
if
(
$
tags_sorted
!==
$
tags
) {
$
tags
=
$
tags_sorted
;
unset(
$
tags_sorted
);
}
else
{
if
(
'
RAND
'
===
$
args
[
'
order
'
] ) {
shuffle
(
$
tags
);
}
else
{
// SQL cannot save you; this is a second (potentially different) sort on a subset of data.
if
(
'
name
'
===
$
args
[
'
orderby
'
] ) {
uasort
(
$
tags
,
'
_wp_object_name_sort_cb
'
);
}
else
{
uasort
(
$
tags
,
'
_wp_object_count_sort_cb
'
);
}
if
(
'
DESC
'
===
$
args
[
'
order
'
] ) {
$
tags
=
array_reverse
(
$
tags
,
true
);
}
}
}
if
(
$
args
[
'
number
'
] >
0
)
$
tags
=
array_slice
(
$
tags
,
0
,
$
args
[
'
number
'
] );
$
counts
=
array
();
$
real_counts
=
array
();
// For the alt tag
foreach
( (
array
)
$
tags
as
$
key
=>
$
tag
) {
$
real_counts
[
$
key
] =
$
tag
->
count
;
$
counts
[
$
key
] =
call_user_func
(
$
args
[
'
topic_count_scale_callback
'
],
$
tag
->
count
);
}
$
min_count
=
min
(
$
counts
);
$
spread
=
max
(
$
counts
) -
$
min_count
;
if
(
$
spread
<=
0
)
$
spread
=
1
;
$
font_spread
=
$
args
[
'
largest
'
] -
$
args
[
'
smallest
'
];
if
(
$
font_spread
<
0
)
$
font_spread
=
1
;
$
font_step
=
$
font_spread
/
$
spread
;
// Assemble the data that will be used to generate the tag cloud markup.
$
tags_data
=
array
();
foreach
(
$
tags
as
$
key
=>
$
tag
) {
$
tag_id
=
isset
(
$
tag
->
id
) ?
$
tag
->
id
:
$
key
;
$
count
=
$
counts
[
$
key
];
$
real_count
=
$
real_counts
[
$
key
];
if
(
$
translate_nooped_plural
) {
$
title
=
sprintf
(
translate_nooped_plural
(
$
translate_nooped_plural
,
$
real_count
),
number_format_i18n
(
$
real_count
) );
}
else
{
$
title
=
call_user_func
(
$
args
[
'
topic_count_text_callback
'
],
$
real_count
,
$
tag
,
$
args
);
}
$
tags_data
[] =
array
(
'
id
'
=>
$
tag_id
,
'
url
'
=>
'
#
'
!=
$
tag
->
link
?
$
tag
->
link
:
'
#
'
,
'
role
'
=>
'
#
'
!=
$
tag
->
link
?
''
:
'
role="button"
'
,
'
name
'
=>
$
tag
->
name
,
'
title
'
=>
$
title
,
'
slug
'
=>
$
tag
->
slug
,
'
real_count
'
=>
$
real_count
,
'
class
'
=>
'
tag-link-
'
.
$
tag_id
,
'
font_size
'
=>
$
args
[
'
smallest
'
] + (
$
count
-
$
min_count
) *
$
font_step
,
);
}
/**
* Filters the data used to generate the tag cloud.
*
* @since 4.3.0
*
* @param array $tags_data An array of term data for term used to generate the tag cloud.
*/
$
tags_data
=
apply_filters
(
'
wp_generate_tag_cloud_data
'
,
$
tags_data
);
$
a
=
array
();
// generate the output links array
foreach
(
$
tags_data
as
$
key
=>
$
tag_data
) {
$
class
=
$
tag_data
[
'
class
'
] .
'
tag-link-position-
'
. (
$
key
+
1
);
$
a
[] =
"
<a href='
"
.
esc_url
(
$
tag_data
[
'
url
'
] ) .
"
'
"
.
$
tag_data
[
'
role
'
] .
"
class='
"
.
esc_attr
(
$
class
) .
"
' title='
"
.
esc_attr
(
$
tag_data
[
'
title
'
] ) .
"
' style='font-size:
"
.
esc_attr
(
str_replace
(
'
,
'
,
'
.
'
,
$
tag_data
[
'
font_size
'
] ) .
$
args
[
'
unit
'
] ) .
"
;'>
"
.
esc_html
(
$
tag_data
[
'
name
'
] ) .
"
</a>
"
;
}
switch
(
$
args
[
'
format
'
] ) {
case
'
array
'
:
$
return
=&
$
a
;
break
;
case
'
list
'
:
$
return
=
"
<ul class='wp-tag-cloud'>
\n\t
<li>
"
;
$
return
.=
join
(
"
</li>
\n\t
<li>
"
,
$
a
);
$
return
.=
"
</li>
\n
</ul>
\n"
;
break
;
default
:
$
return
=
join
(
$
args
[
'
separator
'
],
$
a
);
break
;
}
if
(
$
args
[
'
filter
'
] ) {
/**
* Filters the generated output of a tag cloud.
*
* The filter is only evaluated if a true value is passed
* to the $filter argument in wp_generate_tag_cloud().
*
* @since 2.3.0
*
* @see wp_generate_tag_cloud()
*
* @param array|string $return String containing the generated HTML tag cloud output
* or an array of tag links if the 'format' argument
* equals 'array'.
* @param array $tags An array of terms used in the tag cloud.
* @param array $args An array of wp_generate_tag_cloud() arguments.
*/
return
apply_filters
(
'
wp_generate_tag_cloud
'
,
$
return
,
$
tags
,
$
args
);
}
else
return
$
return
;
}
/**
* Serves as a callback for comparing objects based on name.
*
* Used with `uasort()`.
*
* @since 3.1.0
* @access private
*
* @param object $a The first object to compare.
* @param object $b The second object to compare.
* @return int Negative number if `$a->name` is less than `$b->name`, zero if they are equal,
* or greater than zero if `$a->name` is greater than `$b->name`.
*/
function
_wp_object_name_sort_cb
(
$
a
,
$
b
) {
return
strnatcasecmp
(
$
a
->
name
,
$
b
->
name
);
}
/**
* Serves as a callback for comparing objects based on count.
*
* Used with `uasort()`.
*
* @since 3.1.0
* @access private
*
* @param object $a The first object to compare.
* @param object $b The second object to compare.
* @return bool Whether the count value for `$a` is greater than the count value for `$b`.
*/
function
_wp_object_count_sort_cb
(
$
a
,
$
b
) {
return
(
$
a
->
count
>
$
b
->
count
);
}
//
// Helper functions
//
/**
* Retrieve HTML list content for category list.
*
* @uses Walker_Category to create HTML list content.
* @since 2.1.0
* @see Walker_Category::walk() for parameters and return description.
* @return string
*/
function
walk_category_tree
() {
$
args
=
func_get_args
();
// the user's options are the third parameter
if
(
empty
(
$
args
[
2
][
'
walker
'
] ) || ! (
$
args
[
2
][
'
walker
'
]
instanceof
Walker ) ) {
$
walker
=
new
Walker_Category
;
}
else
{
$
walker
=
$
args
[
2
][
'
walker
'
];
}
return
call_user_func_array
(
array
(
$
walker
,
'
walk
'
),
$
args
);
View remainder of file in raw view
Back
|
FazBrowse Home
|
New Git URL