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

wp_list_bookmarks( string|array $args = '' )

检索或回显所有书签(bookmarks)

bookmark

listmore...


描述

默认参数列表如下:

如果“categorize”为1,则这些选项定义了类别名称在显示类别链接之前的显示方式。如果“categorize”为0,则它将仅为‘title_li’字符串显示,并且仅当‘title_li’不为空时显示。

另见


参数

$args

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

  • 'orderby'
    (string) 如何按顺序排列链接。接受post字段。默认'name'。
  • 'order'
    (string) 是按升序还是降序排列书签。接受“ASC”(升序)或“DESC”(降序)。默认值“ASC”。
  • 'limit'
    (int) 要显示的书签数量。接受 1+ 或 -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。
  • 'echo'
    (int|bool) 是回显还是返回格式化的书签。接受 1|true(echo)或 0|false(return)。默认 1|true。
  • 'categorize'
    (int|bool) 是按类别还是在单个列中显示链接。接受 1|true(按类别)或 0|false(一列)。默认 1|true。
  • 'show_description'
    (int|bool) 是否显示书签描述。接受 1|true 或 0|false。默认 0|false。
  • 'title_li'
    (string) 链接出现之前要显示的内容。默认的“Bookmarks”。
  • 'title_before'
    (string) 要前置到$title_li字符串的HTML或文本。默认值<h2>
  • 'title_after'
    (string) 要附加到$title_li字符串的HTML或文本。默认值</h2>
  • 'class'
    (string|array) 用于$title_li的CSS类或类数组。默认值为“linkcat”。
  • 'category_before'
    (string) 如果$categorize为true,则在$title_before前面加上的HTML或文本。字符串必须包含'%id'和'%class',才能继承类别id和用于在主题中格式化的$class参数。默认值<li id="%id" class="%class">
  • 'category_after'
    (string) 如果$categorize为true,则要附加到$title_after的HTML或文本。默认值</li>
  • 'category_orderby'
    (string) 如果$categorize为true,如何根据分类项(term)方案对书签类别进行排序。默认'name'。
  • 'category_order'
    (string) 如果$categorize为true,则是否按升序或降序对类别排序。接受“ASC”(升序)或“DESC”(降序)。默认值“ASC”。

默认值: ''


返回

(void|string) 如果'echo'参数为true,则无返回;如果'echo'为false,则返回HTML书签列表。



源码

查看源码 官方文档


更新日志

版本描述
2.1.0开始引入

使用示例

  • 示例1

    简单列表

    显示标题为“bookmarks”且项目包装在标记中的所有书签。标题用h2标记包装。

    <?php wp_list_bookmarks('title_li=&category_before=&category_after='); ?>
    
  • 示例2

    不带标题的简单列表

    如上所述显示所有书签,但不包括默认标题。

    <?php wp_list_bookmarks('title_li=&categorize=0'); ?>
    
  • 示例3

    按URL排序的特定类别

    在span标记中显示类别ID 2的书签,使用图像作为书签,不显示描述,按书签URL排序。

    <?php wp_list_bookmarks('categorize=0&category=2&before=<span>&after=</span>&show_images=1&show_description=0&orderby=url'); ?>
    
  • 示例4

    显示分级和时间戳

    在一个有序列表中显示所有书签,并在新行上显示说明,不使用图像作为书签,按书签id排序,显示分级和上次更新的时间戳(注意,上次更新的时间戳不跟踪本地修改。它跟踪链接指向的任何内容何时通过对pingomatic的远程请求更新。)

    <ol>
    <?php wp_list_bookmarks('between=<br />&show_images=0&orderby=id&show_rating=1&show_updated=1'); ?>
    </ol>
    
  • 示例5

    用图像替换标题

    使用主题文件夹中的图像,而不是纯文本。

    <?php wp_list_bookmarks('categorize=0&title_before=&title_after=&title_li=<img src="'.get_bloginfo("stylesheet_directory").'/images/blogroll.gif" alt="blogroll" />'); ?>