最近帮别人做了一个主题,其中大量用到了wp_list_categories函数。所以说,别看它简单,用起来才发现其妙无穷。下面就介绍一下wp_list_categories函数的具体用法。
说明
将分类以列表的形式显示为链接。点击分类的链接,就可以访问该分类下的所有文章的存档页面。
注意: wp_list_categories() 和 list_cats() 以及 wp_list_cats() 的使用类似,但是后面 2 个已经弃用。
如果你希望不格式化输出分类,请使用 get_categories()
用法
1 |
<?php wp_list_categories( $args ); ?> |
默认用法
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 |
<?php $args = array( 'show_option_all' => '', 'orderby' => 'name', 'order' => 'ASC', 'style' => 'list', 'show_count' => 0, 'hide_empty' => 1, 'use_desc_for_title' => 1, 'child_of' => 0, 'feed' => '', 'feed_type' => '', 'feed_image' => '', 'exclude' => '', 'exclude_tree' => '', 'include' => '', 'hierarchical' => 1, 'title_li' => __( 'Categories' ), 'show_option_none' => __('No categories'), 'number' => null, 'echo' => 1, 'depth' => 0, 'current_category' => 0, 'pad_counts' => 0, 'taxonomy' => 'category', 'walker' => null ); ?> |
参数
show_option_all
(字符串)非空值会导致如果样式设置为列表显示所有类别的链接。默认值是不显示链接到所有分类。
orderby
(字符串)以分类名称、分类ID或文章数量等为排列依据。有效值:
- ID
- name – 默认
- slug
- count
- term_group
order
(字符串)分类的排序顺序(升序或降序)。缺省为升序。有效值:
- ASC – 升序(默认)
- DESC – 降序
style
(字符串)分类列表显示的样式。将分类列表的方式显示(使用<br >标签分隔列表项)。默认设置为列表(无序列表)。有效值:
- list – 默认
- none
show_count
(布尔)显示文章数量。默认情况下不显示文章数量。有效值:
- 1 (True)
- 0 (False) – 默认
hide_empty
(布尔)隐藏没有文章的分类。 默认情况下隐藏没有文章的分类。有效值:
- 1 (True) – 默认
- 0 (False)
use_desc_for_title
(布尔)是否将分类描述作为分类链接中的 title 属性,默认为 true。有效值:
- 1 (True) – 默认
- 0 (False)
child_of
(整数)只显示此参数确定的分类的子分类。此参数没有默认值。
feed
(字符串)显示每个分类的 RSS-2 Feed链接到设置的feed文字。默认不显示feed文字和链接。
feed_type
(字符串)
feed_image
(字符串)设置一个图片到分类的 RSS-2 Feed链接。这个参数会覆盖上面的 feed 参数。此参数没有默认值。
exclude
(字符串)排除一个或多个分类。使用逗号分隔每个分类的ID。参数 include 必须为空。
exclude_tree
(字符串)排除分类树。使用逗号分隔每个分类的ID。参数 include 必须为空。如果 hierarchical 参数 为 true ,请使用 exclude 参数替代 exclude_tree 。
include
(字符串)只显示特定的分类,使用逗号分隔每个分类的ID。
hierarchical
(布尔)以层级来显示分类的子分类。默认为 true(在分类的下面显示它们的子分类)。有效值:
- 1 (True) – 默认
- 0 (False)
title_li
(字符串)设置列表的标题。默认为“Categories”。如果存在这个参数,但是值为空,将无法显示列表。
number
(整数)设置显示的分类数量。定义SQL的限制值。默认为不限制。
echo
(布尔) 显示结果或保存在一个变量里。默认为 True 。有效值:
- 1 (True) – 默认
- 0 (False)
depth
(整数)显示分类的深度(即显示多少层的子分类)。默认值为 0(显示所有分类和子分类)。有效值:
- 0 – 所有分类和子分类(默认)
- -1 – 所有类别显示在平面(不缩进)的形式(覆盖hierarchical)。
- 1 – 只显示顶级分类
- n – 根据n的具体数字来显示对应等级的分类。
current_category
(整数)后跟分类ID号,对此ID分类加入名为current-cat的CSS控制,用户自定义current-cat样式后,可用于突出显示。
pad_counts
(布尔)计算包括子分类的链接或文章数。如果 show_counts 和 hierarchical 为 true ,这个参数就自动设置为 true 。有效值:
- 1 (true)
- 0 (false) – 默认
taxonomy
(字符串)要返回的分类法。该参数是在 3.0 中添加的。有效值:
- category – 默认
- taxonomy – 或任何其他已注册的分类法
walker
(对象)生成列表 Walker 类。有效值:
object – an instance of a class that extends either Walker_Category or Walker
示例
包含或排除分类
按字母顺序排序分类,只包括类别ID为 16,3,9和5 的分类,你可以使用下面的代码:
1 2 3 |
<ul> <?php wp_list_categories('orderby=name&include=3,5,9,16'); ?> </ul> |
根据名称排列,显示文章数,并且排除ID为 10 的分类:
1 2 3 |
<ul> <?php wp_list_categories('orderby=name&show_count=1&exclude=10'); ?> </ul> |
只显示指定分类的子分类
显示ID为 8 的分类的子分类,根据ID排序,显示文章数,并且将分类描述作为连接的 title属性。注意:如果父分类没有文章,将不显示父分类。
1 2 3 |
<ul> <?php wp_list_categories('orderby=id&show_count=1&use_desc_for_title=0&child_of=8'); ?> </ul> |