wp_list_bookmarks
wp_list_bookmarks 是 WordPress 中用来显示友情链接的一个函数,本文主要讲解该函数的参数设置和使用。目前大部分主题都用 wp_list_bookmarks 这个函数来显示友情链接,而目前一些中文的文档不管是翻译还是讲解的都不是很合本人的胃口,所以打算将之重新整理一翻。
wp_list_bookmarks函数的作用
用来按照使用者的意图,来显示友情链接的一个函数。
wp_list_bookmarks 参数
$args = array ( 'orderby' => 'name', 'order' => 'ASC', 'limit' => - 1, 'category' => '', 'exclude_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" class="%class">', 'category_after' => '</li>' ); wp_list_bookmarks ( $args );
参数详解
如果你对 WordPress 的常规参数命名不慎了解的话,
那么你可以继续往下看。
另外下面显示的都是参数的默认值,
也就是说没有特别要求的话,你可以不用设置这些参数,
只需要明确标出你需要改动的即可,其他的可以不用写。
// 按啥排序
'orderby' => 'name',
//升序、降序
'order' => 'ASC',
//输出多少条
'limit' => -1,
//指定分类id
'category' => '',
//排除分类id
'exclude_category' => '',
//指定要显示的分类名,貌似不好用版本3.4.1
'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',
//分类的CSS中的class值
'class' => 'linkcat',
//分类前HTML代码%id和%class是系统默认占位符
'category_before' => '<li id="%id" class="%class">',
//分类后HTML代码
'category_after' => '</li>'
wp函数中一般都有两种参数赋值方式,一种是数组形式的,另一种是字符串形式的,
因为结构清晰便于复用,所以我一般喜欢用数组形式来给参数赋值,
这样不但看起来省事,实际上也少一步PHP解析字符串的过程。
使用实例
下面贡献一段我自己主题的代码
wp_list_bookmarks ( array ( 'orderby' => 'rand', // 随机排序 'category' => '2', // 显示的分类ID 'title_before' => '<div id="linkstitle">', 'title_after' => '</div>', 'category_before' => '', 'category_after' => '' ) );
简单的链接列表
显示所有链接,标题为“Bookmarks”,各链接项包围在<li>标签中,标题则用<h2>标签。
<?php wp_list_bookmarks('title_li=&category_before=&category_after='); ?>
没有标题的简单列表
按上一个例子的条件显示所有链接,但不包括默认标题。
<?php wp_list_bookmarks('title_li=&categorize=0'); ?>
显示某个分类下的所有链接
显示ID为2的链接分类下的所有链接,使用链接图片,不显示链接说明,按URL排列链接。
<?php wp_list_bookmarks('categorize=0&category=2&before=<span>&after=</span>&show_images=1&show_description=0&orderby=url'); ?>
显示链接等级和时间标记
以数字编号列表形式显示所有链接,各链接下另起一行填写链接说明,不适用链接图片,按ID排列链接,显示链接等级和最新更新的时间。
<ol>
<?php wp_list_bookmarks('between=<br />&show_images=0&orderby=id&show_rating=1&show_updated=1'); ?>
</ol>
用图片取代标题
从主题目录中选择一个图片代替普通文本作为链接列表标题。
<?php wp_list_bookmarks('categorize=0&title_before=&title_after=&title_li=<img src="'.get_bloginfo("stylesheet_directory").'/images/blogroll.gif" alt="blogroll" />'); ?>
小结:
1.总的来说,要用好wp_list_bookmarks()函数,需