WordPress:Template Tags/wp list bookmarks

描述

这个函数是在WordPress2.1版本时，引进的。wp_list_bookmarks()，显示管理 > 友情链接 > 管理友情链接面板中出现的书签。这个[WordPress:Template_Tags|模板标签]]允许用户控制书签的分类，显示方式，而且试图替换模板标签'get_links_list()' 和'get_links()'。

用法

%%% <?php wp_list_bookmarks('arguments'); ?> %%%

例子

默认用法

$defaults = array(
'orderby' => 'name',
'order' => 'ASC',
'limit' => -1,
'category' => '',
'category_name' => '',
'hide_invisible' => 1,
'show_updated' => 0,
'show_description' => 1,
'echo' => 1,
'categorize' => 1,
'title_li' => __('Bookmarks'),
'title_before' => '<h2>',
'title_after' => '</h2>',
'category_orderby' => 'name',
'category_order' => 'ASC',
'class' => 'linkcat',
'category_before' => '<li id="%id" class="%class">',
'category_after' => '</li>'
);

默认情况下，用法显示：

• Bookmarks分成了拥有类别名的类别。

• 不管类别ID，或者类别名，包含了所有bookmarks

• 根据名称给列表分类

• 如果包含了图像，就会有一个图像

• 图像和文本之间拥有一个空格

• 显示关于bookmark的描述

• 不显示级别

• 除非设置了限制，否则显示所有的bookmarks

• 显示bookmarks

<?php wp_list_bookmarks(); ?>

简单的列表

显示所有的bookmarks，带有标题"Bookmarks"，同时将items放入<li>标签。这个标题包裹在h2标签中。

<?php wp_list_bookmarks('title_li=&category_before=&category_after='); ?>

没有标头的简单列表

如上所述，显示所有的bookmarks，但是不包含默认标头。

<?php wp_list_bookmarks('title_li=&categorize=0'); ?>

根据URL分类的特别的类别

在span标签中显示类别ID2的bookmarks，为bookmarks使用图像，不显示描述，根据bookmarkURL分类。

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

显示级别和时间标记

在一个有序的列表上显示所有的bookmarks，另起一行加上描述，不为bookmarks使用图像，根据bookmark id 分类，显示级别和最后更新的时间。

<ol>

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

参数

categorize

(boolean) Bookmarks必须在指定的类别中显示(TRUE)或者不必在指定的类别中显示(FALSE)。默认为TRUE。

• 1 (True - default)
• 0 (False)

category

(string) 用逗号分开列表上将要显示的类别ID。如果没有特别规定，拥有bookmarks的所有类别都会显示。默认为（所有类别）。

category_name

(string) 将要显示bookmarks的类别的名称。如果没有特别规定，拥有bookmarks的所有的类别都会显示。默认为（所有类别）。

category_before

(string)每个类别之前放置的文本。默认为'<li id="[category id]" class="linkcat">'。

category_after

(string) 每个类别之前放置的文本。默认为'<'/li>'。

class

(string) 每个类别li从属的class。默认为'linkcat'。

category_orderby

(string) 给类别分类的参数。默认为'name'。有效的参数值：

• 'name' (Default)
• 'id'
• 'slug'
• 'count'
• 'term_group' (not used yet)

category_order

(string) 类别顺序，category_orderby参数升序或者降序。有效的参数值：

• ASC (默认)
• DESC

title_li

(string) 链接列表标头的文本。默认为'__('Bookmarks')'，显示"Bookmarks"（__('')用作本地化目的）。只当类别设置为0的时候，才会使用（否则会使用类别名代替）。如果验证通过了零（0）值，不显示标头，而且列表不会包裹在<ul>, </ul>标签内部。

title_before

(string)如果'categorize'是TRUE，每个类别描述之前放置的文本。默认为'<h2>'。

title_after

(string)如果'categorize'是TRUE，每个类别描述之后放置的文本。默认为'</h2>'。

；show_private : (boolean)如果类别被规定为保密的，类别是否应该显示。忽视管理设置，并且显示保密的类别(TRUE)还是不显示保密的类别(FALSE)。默认为FALSE。

• 1 (True)
• 0 (False - default)

include

(string) 用逗号分开列表上的bookmark的ID数字，并且将其包含在输出中。例如，, 'include=1,3,6'指的是返回或者echo bookmark ID1，3，和6。如果使用了包含字符串，便忽视了category, category_name, 和 exclude参数。默认为（所有的Bookmarks）。

exclude

(string) 删除列表上用逗号分开的bookmark ID 数字。例如，'exclude=4,12'指的是bookmark ID 为4和12的bookmark不会返回或者echod。默认为（不删除任何内容）。

orderby

(string) 给bookmark分类的参数。默认为'name'，除非你验证通过了参数'' (empty),在这种情况下，设置为'id'。有效的选项：

• 'id'
• 'url'
• 'name'
• 'target'
• 'description'
• 'owner' - 通过bookmarks管理器添加bookmark的用户
• 'rating'
• 'updated'
• 'rel' - bookmark关系 (XFN).
• 'notes'
• 'rss'
• 'length' - bookmark名称的长度，从最短到最长。
• 'rand' - 以任意的顺序显示bookmarks。

order

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

• ASC (Default)
• DESC

limit

(integer) 最多显示的bookmarks的数目。默认为-1（所有的bookmarks）。

before

(string) 每个bookmark之前放置的文本。默认为'<li>'。

after

(string) 每个bookmark之后放置的文本。默认为'</li>'。

category_before

(string) 每个类别之前放置的文本。默认为'<li>'，拥有适当的id和class。

category_after

(string) 每个类别之后放置的文本。默认为'</li>'。

between

(string) 每个bookmark/image 和各自的描述之间放置的文本。默认为'\n'(换行)。

show_images

(boolean)关于bookmarks的图像应该显示(TRUE) 或者不显示(FALSE)。默认为TRUE。

• 1 (True - default)
• 0 (False)

show_description

(boolean) 描述应该显示(TRUE) 或者不应该显示 (FALSE)。当show_images是FALSE，或者没有定义一个图像的时候，是有效的。默认为FALSE。

• 1 (True)
• 0 (False - default)

show_rating

(boolean) 等级级别stars/字符应该显示(TRUE)或者不应该显示 (FALSE)。默认为FALSE。

• 1 (True)
• 0 (False - default)

show_updated

(boolean) 最后更新的时间应该显示(TRUE)或者不应该显示 (FALSE)。默认为FALSE。

• 1 (True)
• 0 (False - default)

hide_invisible

(boolean) 即时bookmark的可视设置为否定的，也应该显示这个bookmark，遵从管理设置(TRUE)或者不遵从管理设置(FALSE)。默认为TRUE。

• 1 (True - default)
• 0 (False)

echo

(boolean) Display bookmarks (TRUE) or return them for use by PHP (FALSE). Defaults to TRUE.

• 1 (True - default)
• 0 (False)

相关的

How to pass parameters to tags with PHP function-style parameters

Go to Template Tag index