说明
该标签显示含链接的博客分类目录列表。用户点击某个分类目录后,WordPress运行由模板层级规则指定的相应分类模板,在分类页面上显示该分类目录下所有日志。
用法
<?php wp_list_categories( $args ); ?>
默认用法
<?php $args = array(
'show_option_all' => ,
'orderby' => 'name',
'order' => 'ASC',
'show_last_update' => 0,
'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' => ,
'current_category' => 0,
'hierarchical' => true,
'title_li' => __( 'Categories' ),
'number' => NULL,
'echo' => 1,
'depth' => 0 ); ?>
默认情况下的用法:
- 不显示分类目录链接
- 按升序排列分类目录列表中的分类目录名称
- 不显示最近更新(分类目录下最新更新的日志)
- 以无序列表形式显示列表
- 不显示分类目录下的文章总数
- 只列出含有文章的分类目录
- 将属性设为分类目录的说明
- 不限制分类下是否有子分类
- 不使用feed或feed图片
- 不删除任何分类目录
- 子分类目录缩进显示在其父分类目录下
- 在列表上方显示分类目录字样
- 不强制使用SQL LIMIT语句
- 显示各个分类目录
- 不限制子分类的层数
- 显示所有分类目录
参数
show_option_all
(字符串)若该函数有一个style参数,那么非空的show_option_all值将会显示所有分类目录的链接。默认值为不显示链接。
orderby
(字符串)按字母顺序、ID或分类目录下的日志数量为分类目录排序。默认值为按分类名称排序。
有效值包括:
- ID
- name —— 默认值
- slug
- count
- term_group
order
(字符串)为分类目录排序(升序或降序)。默认值为ascending(升序)。有效值包括:
- ASC ——默认值
- DESC
show_last_updated
(布尔型)是(TRUE)否(FALSE)显示最新更新日志的时间标记。默认值为FALSE。
有效值包括:
- 1 (true)
- 0(false)——默认值
style
(字符串)用以显示分类列表的样式表。值list以列表项显示分类目录;值none可生成常规显示方式(列表项由<br>标签隔开)。list为默认值(为无序列表生成列表项)。有效值包括:
- list —— 默认值
- none
show_count
(布尔型)准备显示每个分类目录下现有的日志总数。默认值为false(不显示日志数量)。有效值包括:
- 1 (true)
- 0(false)——默认值
hide_empty
(布尔型)不显示不含有文章的分类目录。默认值为true(隐藏空分类)。有效值包括:
- 1 (true)——默认值
- 0(false)
use_desc_for_title
(布尔型)设置是否将分类的说明插入到分类目录链接的title属性中(如<a title="<em>Category Description</em>" href="…)。默认值为true(插入分类说明)。有效值包括:
- 1 (true)——默认值
- 0(false)
child_of
(整数)只显示该参数指定的分类下的子分类。该参数无默认值。
feed
(字符串)显示每个分类目录的 rss-2订阅链接并设置链接文本。默认值为no text and no feed displayed(不显示链接文本与feed)。
feed_type
(字符串)
feed_image
(字符串)为某图片设置URI(通常为rss订阅图标),作为分类目录rss-2的订阅链接。该参数将改写feed参数。无默认值。
exclude
(字符串)从结果中排除一个或多个分类目录。该参数按ID升序排列分类列表,各分类用逗号隔开。参见下文中的示例。child_of参数自动设为false。
exclude_tree
(字符串)从结果中排除分类目录树。该参数引入于WP 2.7.1。
include
(字符串)仅包含分类列表中的分类目录,该列表按ID升序排列分类目录,各分类用逗号隔开。参见下文中的示例“排除或包含分类目录”。
hierarchical
(布尔型)将子分类目录显示为内部列表项(内嵌于其父分类目录下)或内嵌列表。默认值为true(在父分类目录下显示其子分类目录)。有效值包括:
- 1 (True)—— 默认值
- 0 (False)
title_li
(布尔型)设置外部列表的标题和样式。默认值为"_Categories"。若该参数有值但为空,则不显示外部列表项。参见下文中的示例。
number
(整数)设置分类目录的数量并显示出来。这将使SQL LIMIT值被定义。默认值为无限数量。
echo
(布尔型)显示结果,或将结果保留在变量中。默认值为true(显示经过整理的分类目录)。该参数引入于WP 2.3。有效值包括:
- 1 (true)——默认值
- 0(false)
depth
(整数)该参数决定分类目录列表中分类目录层级允许的层数。默认值为0(显示所有分类及其子分类)。参数引入于WP 2.5。
- 0 —— 显示所有所有分类目录及其子分类目录(默认值)
- -1 ——以平面形式(不缩进)显示所有分类目录(覆盖hierarchical参数)
- 1 —— 只显示顶级分类目录
- n —— n的值决定了分类目录层级的层数。
current_category
(整数)该参数允许用户在非分类存档页面上显示“当前分类”。正常情况下,当前分类只能在分类存档页面中设置。如果要将该参数用在其它地方,或希望用该参数高亮显示某个分类,会改变函数对“当前”分类的定义。该参数引入于WP 2.6。
示例
包含或排除分类目录
若要按字母顺序排列分类目录,并且只包含ID为16、3、9、5的分类目录,可使用以下代码:
<ul>
<?php
wp_list_categories('orderby=name&include=3,5,9,16'); ?>
</ul>
下面的代码则按分类目录名称显示分类链接,并给出各分类目录下的日志总数,将ID为10的分类从列表中排除。
<ul>
<?php
wp_list_categories('orderby=name&show_count=1&exclude=10'); ?>
</ul>
显示或隐藏列表标题
title_li参数负责设定或隐藏由wp_list_categories生成的、分类目录列表的标题。默认标题为'(__('Categories')',将“Categories(分类目录)”作为列表标题。若title_li参数被设为控制,则不显示列表标题。下面的代码示例从列表中排除ID为4与7的分类目录并隐藏列表标题:
<ul>
<?php
wp_list_categories('exclude=4,7&title_li='); ?>
</ul>
而下面这个示例, 只在列表中显示ID为9、5、23的分类,并将列表名称改为“Poetry” ,标题样式为<h2>:
<ul>
<?php
wp_list_categories('include=5,9,23&title_li=<h2>' . __('Poetry') . '</h2>' ); ?>
</ul>
仅显示分类目录下的子分类
下面的代码为ID为8的分类目录下的子分类生成分类链接,并按ID进行排列;代码还显示出每个分类下的日志总数,隐藏链接title属性中的分类描述。注意:若某个父分类下没有日志,则不显示该父分类。
<ul>
<?php wp_list_categories('orderby=id&show_count=1
&use_desc_for_title=0&child_of=8'); ?>
</ul>
删除分类计数中的括号
show_count=1时,所有分类计数都用括号围绕。若要在不修改核心WordPress文件的情况下删除括号,可使用以下代码:
<?php
$variable = wp_list_categories('echo=0&show_count=1&title_li=<h2>Categories</h2>');
$variable = str_replace(array('(',')'), '', $variable);
echo $variable;
?>
显示带有RSS订阅链接的分类目录
下面这个例子生成以名称排序的分类目录链接,显示每个分类下的日志总数以及各个分类的RSS订阅链接。
<ul>
<?php
wp_list_categories('orderby=name&show_count=1&feed=RSS'); ?>
</ul>
若要将链接换成订阅图标,可:
<ul>
<?php
wp_list_categories('orderby=name&show_count=1
&feed_image=/images/rss.gif'); ?>
</ul>
设计分类目录列表的样式
默认情况下,wp_list_categories()函数在一个标题为“Categories”的列表项(li)内生成一个嵌套的无序列表(ul)。
你可以将title_li参数设为空字符串,以此删除外部的列表项。你可以选择将输出结果包裹在一个数字编号的有序列表(ol)或无序列表中。如果完全不需要列表输出结果,将style参数设为none。
可以用下面这些CSS选择器设计输出结果的样式。
li.categories { … } /* outermost list item */
li.cat-item { … }
li.cat-item-7 { … } /* category ID #7, etc */
li.current-cat { … }
li.current-cat-parent { … }
ul.children { … }
历史记录
- 始见于WordPress 2.1.0版本
- WP 2.3.0 :新增echo参数
- WP 2.5.0 :新增depth参数
- WP 2.6.0 :新增current_category参数
- WP 2.7.1 :新增exclude_tree参数
源文件
wp_list_categories()位于 wp-includes/category-template.php
分类:中文手册