【函数介绍】

get_bookmarks()函数用于获取友情链接,返回链接的数组。

【使用方法】

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

默认返回数据:

  • 所有的bookmarks根据名称,按升序排列。
  • 标记为隐藏的Bookmarks不会返回。
  • The link_updated_f field(以时间戳形式出现的更新时间)不会返回。

【参数说明】

orderby
(string)给bookmark分类的参数。默认为’名称’,除非你验证通过了参数” (空的),在这种情况下,设置为’id’。有效的选项:

  • 'link_id' – Before WordPress 3.2: 'id'
  • 'url'
  • 'name' – Default
  • 'owner' – User who added bookmark through bookmarks Manager.
  • 'rating'
  • 'visible'
  • 'length' – The length of the bookmark name, shortest to longest.
  • 'rand' – Display bookmarks in random order.

order
(string)分类顺序,根据参数的升序或者降序。有效的参数值:

  • ASC (默认)
  • DESC

limit
(整型) 返回链接数. 默认 -1 (所有链接).
category
(字符串)用逗号分开列表上bookmark类别的ID。
category_name
(string)需要返回的bookmark的类别名称。撤除了类别参数。
hide_invisible
(boolean)正确的,导致拥有link_visible设置为’Y’的bookmarks返回。

  • 1 (正确的 – 默认)
  • 0 (错误的)

show_updated
(boolean’)TRUE导致了一个额外的,称为”link_category_f”的栏,插入了结果中,结果包含了与”link_updated”相同的值,但是是以unix时间戳的格式。在这个数据上使用PHP日期函数非常方便。

  • 1 (正确的)
  • 0 (错误的 – 默认)

include
(string)用逗号分开列表上的bookmark的ID数字,并且将其包含在输出中。例如,, ‘包含=1,3,6’指的是返回或者echo bookmark ID1,3,和6。如果使用了包含字符串,便忽视了类别, category_name, 和 删除参数。默认为(所有的Bookmarks)。
exclude
(string) Comma separated list of numeric bookmark IDs to exclude. For example, ‘exclude=4,12’ means that bookmark IDs 4 and 12 will NOT be returned or echoed. Defaults to (exclude nothing).
search
(string) Searches link_url, link_name or link_description like the search string. Defaults to .

【使用实例】

  • – 创建一个链接分类名为 “Related Sites”
  • – 在 “Related Sites” 添加链接数据

代码如下:

<?php
$bookmarks = get_bookmarks( array(
				'orderby'        => 'name',
				'order'          => 'ASC',
				'category_name'  => 'Related Sites'
                          ));

// 循环输出链接
foreach ( $bookmarks as $bm ) { 
    printf( '<a class="relatedlink" href="%s">%s</a><br />', $bm->link_url, __($bm->link_name) );
}
?>