常用函数-get_bookmarks()

2条评论

说明

该函数返回一个书签(收藏链接)数组。该模板标签允许用户直接查找书签信息。

用法

<?php get_bookmarks( $args ); ?> 

默认用法

<?php $args = array(
'orderby' => 'name',
'order' => 'ASC',
'limit' => -1,
'category' => ,
'category_name' => ,
'hide_invisible' => 1,
'show_updated' => 0,
'include' => ,
'exclude' => ,
'search' => ); ?>

参数

orderby

(字符串)以什么顺序排列书签。默认值为'name',除非你传递''(空)值,这时orderby的值将被设为'id'。有效值包括:

  • 'id'
  • 'url'
  • 'name' ——默认
  • 'target'
  • 'description'
  • 'owner' —— 通过书签管理器添加书签的用户
  • 'rating'
  • 'updated'
  • 'rel' ——XFN
  • 'notes'
  • 'rss'
  • 'length' ——书签名称的长度,从最短的到最长的长度。
  • 'rand' —— 以任意顺序显示书签

order

(字符串)排序所依标准,升序或降序。有效值包括:

  • ASC——默认
  • DESC

limit

(整数)需要展示的数千的最大数量。默认值为-1(所有书签)。

category

(字符串)书签分类编号列表,用逗号隔开

category_name

(字符串)即将被检索的书签分类的分类名称。覆盖分类参数。

hide_invisible

(布尔型)若该参数值为TRUE,检索link_visible值设为'Y'的书签。

  • 1(True)——默认值
  • 0(False)

show_updated

(布尔型)若该值为TRUE,结果中会额外插入一个"link_category"的列,该列中包含的值与"link_updated"相同,但为unix时间标记格式。可用于PHP日期函数。

  • 1 (True)
  • 0(False)——默认值

Include

(字符串)输出结果中包含的数字书签编号列表,各编号用逗号隔开。例如 'include=1,3,6' 表示返回或响应编号为1、3、6的数千。若使用了include字符串,category, category_nameexclude都将被忽略。默认值为(all Bookmarks)(所有书签)。

exclude

(字符串)输出结果中需要排除的数字书签编号列表,各编号用逗号隔开。例如,'exclude=4,12'表示不返回或不响应编号为4和12的书签。默认值为 (exclude nothing)(不排除任何书签)。

search

(字符串)搜索link_url, link_name或 link_description等搜索字符串。默认值为.

示例

——创建一个名为“Related Sites”的链接分类

——创建一些链接,使链接隶属于“Related Sites”分类

在网页中使用以下代码来检索链接:

<?php
$bm = get_bookmarks( array(
'orderby' => 'name',
'order' => 'ASC',
'limit' => -1,
'category' => null,
'category_name' => 'Related Sites',
'hide_invisible' => 1,
'show_updated' => 0,
'include' => null,
'exclude' => null,
'search' => '.'));
foreach ($bm as $bookmark){
echo "<a id='relatedlinks' href='{$bookmark->link_url}' target=_blank>
{$bookmark->link_name}
</a><br /><br />\";
}
?>

历史记录

始见于2.1.0版本

源文件

get_bookmarks()位于 wp-includes/functions.php中。

相关资源

wp_list_bookmarks, get_bookmarks, get_bookmark