wp_list_bookmarks 函数全面分析
2.1 版本启用了一个新函数来代替以前常用的 Blogroll 的两个函数 get_links_list() 和 get_links() ,这2个函数可能会在以后的版本中被弃用,所以以后在调用 Blogroll 的时候最好用:
其实这个函数的用法和 wp_list_categories 基本相同,自定义的参数全部都写在了 “(’ ‘)” 里面,并且参数之间用 “&” 连接。
下面是这个函数的默认参数:
$defaults = array('orderby' => 'name', 'order' => 'ASC', 'limit' => -1, 'category' => '',
'category_name' => '', 'hide_invisible' => 1, 'show_updated' => 0, 'echo' => 1,
'categorize' => 1, 'title_li' => __('Bookmarks'), 'title_before' => '<h2>', 'title_after' => '</h2>',
'category_orderby' => 'name', 'category_order' => 'ASC', 'class' => 'linkcat',
'category_before' => '<li id="%id">', 'category_after' => '</li>');
相关参数:
categorize
布尔型,用于设置连接是否按照各自的分类显示:
1 (默认,根据链接的分类显示)
0 (不按照分类,显示全部)
categorize
字符串型,后面就直接 “=链接的分类ID号” ,那么就显示这个分类下的链接。如果没有指定的话就显示所有的链接。
category_name
字符串型,如果后面 “=某个链接分类的名称” 那么就会在该链接分类前显示分类的名称,如果这里留空的话则会显示所有链接分类的分类名称(即默认的形式)。(个人觉得这个参数不常用,一般不用管它)
category_before
字符串型,位于链接分类之前的文字或代码。默认的设置是:
字符串型,位于链接分类之后的文字或代码。默认的设置是:其实这上面2个属性就是用来定义每个连接分类的样式,可以理解成下面这种形式:
字符串型,每一个链接的分类都会有一个 “class” 属性(从上面的代码就能看出),默认是:linkcat
category_orderby
字符串型,链接分类的排序方式,按照名词或者ID。
‘name‘ (默认)
‘id‘
category_order
字符串型,链接分类的升降序排列方式:
ASC (默认)
DESC
title_li
字符串型,链接标题的头文字或代码,默认是:Bookmarks,并且它控制连接是否按照列表的方式排列。
title_before 和 title_after
顾名思义,它们就是连接标题头前后的文字或代码,默认是 h2 标签
上面这2组参数,实际定义的是 Blogroll 上面的头标题,即这个“ Blogroll 分类列表”上的类名。这些大的分类默认是被 li 标签套起来的,然后各个大分类下的链接列表则是套用在 ul 下的 li 进行排列。(是不是看不懂我在说什么?看不懂就跳过…)
show_private
布尔型,是否显示私有链接。
1 (是)
0 (不是 – 默认)
include
字符串型,输出指定 ID 的 Blogroll 的分类链接,各个 ID 之间用半角的 “,” 分开。默认显示所有的 Blogroll 分类。
exclude
字符串型,将指定 ID 的 Blogroll 分类链接从整个链接列表中排除,各个 ID 之间用半角的 “,” 分开。默认是什么都不排除。
orderby
字符串型,
orderby
字符串型,Blogroll 的排列方式(默认是根据名称排序,除非将这个值留空),即根据我们在 WP 后台链接设置界面下的那些参数来进行排序:
‘id’
‘url’
‘name’
‘target’
‘description’
‘owner’
‘rating’
‘updated’
‘rel’ – 按设定的关系排列
‘notes’
‘rss’
‘length’ – 连接名称的长度设定
‘rand’ – 随机排列显示
order
字符串型,设置升降序的排列方式
ASC (默认)
DESC
limit
整型,设置输出链接条数的最大值。默认值是“-1”,输出全部。
before 和 after
字符串型,Blogroll 里每一条连接前面和后面的文字或代码,默认是 li 标签。
category_before 和 category_after
字符串型,各个 Blogroll 分类前后的文字或代码,默认也是 li 标签。
between
字符串型,每个连接、图片和描述之间的文字或代码,默认是 “\n” 换行。
show_images
布尔型,是否允许显示 Blogroll 下链接的对应图片。
1 (允许 – 默认)
0 (不允许)
show_description
布尔型,是否允许显示每个链接的描述。
1 (允许)
0 (不允许 – 默认)
show_rating
布尔型,是否允许显示链接的等级。
1 (允许)
0 (不允许 – 默认)
show_updated
布尔型,是否允许显示最近更新后的时间戳。
1 (允许)
0 (不允许 – 默认)
hide_invisible
布尔型,是否显示所有的链接,甚至是被管理员设为不可见的链接,默认允许显示。
1 (允许 – 默认)
0 (不允许)
echo
布尔型,是否允许显示连接 or return them for use by PHP(怎么翻译?!) (FALSE)。默认允许。
1 (允许 – 默认)
0 (不允许)