当前浏览:首页 / WordPress函数 / get_bookmarks()

get_bookmarks( string|array $args = '' )

检索书签列表

bookmark


描述

尝试首先基于参数的MD5哈希从缓存中检索。如果失败,那么将根据参数构建查询并执行。结果将存储到缓存中。


参数

$args

(string|array)(可选) 用于检索书签的字符串或参数数组。

  • 'orderby'
    (string) 如何按顺序排列链接。接受'id'、'link_id'、'name'、'link_name'、'url'、'link_url'、'visible'、'link_visible'、'rating'、'link_rating'、'owner'、'link_owner'、'updated'、'link_updated'、'notes'、'link_notes'、'description'、'link_description'、'length'和'rand'。当$orderby为'length'时,按'link_name'的字符长度排序。默认值'name'。
  • 'order'
    (string) 是按升序还是降序排列书签。接受'ASC'(升序)或'DESC'(降序)。默认值'ASC'。
  • 'limit'
    (int) 要显示的书签数量。接受任何正数或-1表示全部。默认值-1。
  • 'category'
    (string) 要包含其链接的类别ID的逗号分隔列表。
  • 'category_name'
    (string) 按名称检索链接的类别。
  • 'hide_invisible'
    (int|bool) 是否显示或隐藏标记为'invisible'的链接。接受 1|true 或 0|false。默认 1|true。
  • 'show_updated'
    (int|bool) 是否显示书签上次更新的时间。接受 1|true 或 0|false。默认 0|false。
  • 'include'
    (string) 要包括的书签ID的逗号分隔列表。
  • 'exclude'
    (string) 要排除的书签ID的逗号分隔列表。
  • 'search'
    (string) 搜索词。将采用前后通配符的SQL格式,并在'link_url'、'link_name'和'link_description'中搜索。

默认值: ''


返回

(object[]) 书签行对象列表。



源码

查看源码 官方文档


更新日志

版本描述
2.1.0开始引入

用户贡献的笔记

  • 贡献者:Codex

    实例

    –创建一个名为“Related Sites”的链接类别
    –创建几个链接,将它们添加到“Related Sites”类别中

    您可以在模板中使用以下代码来检索链接:

    $bookmarks = get_bookmarks( array(
    	'orderby'        => 'name',
    	'order'          => 'ASC',
    	'category_name'  => 'Related Sites'
    ) );
    
    // Loop through each bookmark and print formatted output
    foreach ( $bookmarks as $bookmark ) { 
        printf( '<a class="relatedlink" href="%1$s">%2$s</a><br />', esc_attr( $bookmark->link_url ), $bookmark->link_name );
    }