模板标签-get_bookmarks()

1条评论

说明

该标签返回管理面板>链接>编辑菜单中的所有链接。该标签允许用户直接检索链接信息。

用法

<?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' => ); ?>

默认情况下的用法:

  • 以名称顺序对所有链接进行升序排列
  • 不返回标记为隐藏的链接
  • 不返回link_updated_f字段(即更新时间,格式为timestamp(时间标记))

参数

orderby

(字符串)以何顺序为链接排序。默认值为'name',除非你传递' '(空)值给该参数,此时参数值为'id'。有效值包括:

  • 'id'
  • 'url'
  • 'name' ——默认值
  • 'target'
  • 'description'
  • 'owner' —— 通过连接管理器添加链接的用户
  • 'rating'
  • 'updated'
  • 'rel' —— 链接关系(XFN)
  • 'notes'
  • 'rss'
  • 'length' —— 链接名称的长度,范围从最短的名称到最长的名称
  • 'rand' —— 以任意顺序显示链接

order

(字符串)根据'orderby'参数中的设置为分类目录排序(升序或降序)。有效值包括:

  • ASC ——默认值
  • DESC

limit

(整数)可以显示的最大链接数。默认值为-1(所有链接)。

category

(字符串)链接分类目录的ID列表,各ID用逗号隔开。

category_name

(字符串)被检索的链接所属分类的分类名称。覆盖category参数。

hide_invisible

(布尔型)若值为TRUE,仅检索link_visible值为'Y'的链接

  • 1 (true)——默认值
  • 0(false)

show_updated

(布尔型)若值为TRUE,返回的结果中会额外插入一列link_category_f项,该列中包含的值域link_updated相同,但格式为unix时间标记格式。可在此使用PHP日期函数。

  • 1 (true)
  • 0(false)——默认值

include

(字符串)在结果中包含的数值型链接ID列表,各ID用逗号隔开。例如, 'include=1,3,6' 表示返回或响应ID为1、3、6的链接。如果使用include字符串,那么 categorycategory_nameexclude参数将被忽略。默认值为 (all Bookmarks)(所有链接)。

exclude

(字符串)将要被排除的链接的ID,各ID用逗号隔开。如 'exclude=4,12'表示不返回ID为4和12的链接。默认值为 (exclude nothing)(不排除任何链接)。

search

(字符串)查找link_url、link_name或link_description等search字符串。

示例

——生成一个链接分类“相关站点”

——在“相关站点”分类目录下创建若干链接

你可以在页面上用以下代码检索链接:

<?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 />\";
}
?>

历史记录

始见于WordPress 2.1.0版本

源文件

get_bookmarks() 位于 wp-includes/bookmark.php