WordPress中文手册

【函数介绍】

wp_list_bookmarks()是用来获取友情链接的函数。
注：目前很多获取友链的函数都是 get_links_list()或者是get_links()，但未来获取友情链接将被wp_list_bookmarks()函数取代，相较而言wp_list_bookmarks()函数的功能会更强大些。

【使用方法】

<?PHP wp_list_bookmarks( $args ); ?>

【默认使用】

<?php $args = array(   
'orderby'          => 'name',   
'order'            => 'ASC',   
'limit'            => -1,   
'category'         => ,   
'exclude_category' => ,   
'category_name'    => ,   
'hide_invisible'   => 1,   
'show_updated'     => 0,   
'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>' 
);  

在默认情况下该函数将显示如下内容:

• 友链的标题为默认标题
• 包含所有分类的链接
• 按照链接名称排序
• 如果包含图像，则显示之
• 在图像和文字之间有空格
• 显示链接的描述
• 不显示链接分级
• 显示所有的链接

【参数说明】

categorize
(布尔型)不应在他们分配的类别内显示书签。

• 1(True)-默认
• 0(False) False

category
(字符串）以逗号分隔数值显示类别 Id 的列表。如果没有指定，显示所有类别的书签。默认值为 (所有类别)。
exclude_category
(字符串）要从显示中排除数字类别 Id 的逗号分隔列表。默认值为 （不排除类别）。
category_name
(字符串）将显示其书签的类别的名称。如果没有指定，显示所有类别的书签。默认值为 (所有类别)。
category_before

(字符串）放置在每个类别之前的文本。默认值为'<li id="[category id]">'.

category_after

(字符串）每个类别后放置文本。默认值为</li>.

class
(字符串）每个类别李会对它的类。默认值为’linkcat’ 。
category_orderby
(字符串）若要按类别排序的值。有效的选项：

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

category_order
(字符串）排序次序升序或降序的 category_orderby 参数。有效的值：

• ASC -默认
• DESC

title_li

(字符串）链接列表的标题文本。
默认值为'__('Bookmarks')'，其中显示 "Bookmarks" (the __('') 用于本地化。
只有进行分类时使用都设置为 0 [false] （其他类别名称，将使用相反）。
如果 'title_li' 设置为 null (0) 值，则不显示标题，则列表将不会结束与<ul> </ul> （一定要传递给 0 [false]，则此选项才生效的分类选项） 的标签。

title_before

(字符串）将文本放置在每个类别说明之前，如果 '分类' 1 [true]，或在文本中定义"title_li"如果 '分类' 是 0 [false]。默认值为<h2>.

title_after

(字符串）将文本放置每个类别的描述后，如果 '分类' 1 [true] 或文本定义在"title_li"如果 '分类' 是 0 [false]。默认值为' </h2> '.

show_private
(布尔)应即使类别被认为是私人显示一个类别。忽略的管理员设置和显示私人类别 (TRUE) 或不显示 (虚假的私人类别).

• 1（True）
• 0(False)-默认

include
(字符串）以逗号分隔的数字书签 Id 要包含在输出中的列表。例如，’ 包括 = 1，3，6′ 意味着返回或回显书签 Id 1、 3 和 6。如果使用包含字符串，则将忽略的类别、 category_name，和排除的参数。默认值为 （所有书签）。exclude(字符串）以逗号分隔数字书签 Id 来排除的列表。例如，’ 排除 = 4，12′ 意味着书签 Id 4 和 12 将不会返回或回响。默认值为 （不排除）。orderby(字符串）要对书签进行排序的值。这可以用逗号分隔的值列表。除非你的 ‘ ”值传递 （空），在这种情况下，它将设置为id中将默认的名称。有效的选项：

• ‘id’ （使用 ‘ link_id’ 的 WP 3.2 和更高版本)
• ‘url’
• ‘name’ -默认
• ‘target’
• ‘description’
• ‘owner’ -添加书签书签管理器通过用户。
• ‘rating’
• ‘updated’注： link_updated 字段不会跟踪的本地修改。它跟踪链接无论指向 pingomatic 的远程请求通过更新时。
• ‘rel’ -书签关系 (新华财经)。
• ‘notes’
• ‘rss’
• ‘length’ -的书签的名称，最长最短长度。
• ‘rand’-随机显示书签。

order
(字符串）书签显示按升序或降序 ‘orderby’ 参数中定义的排序顺序。有效的值：

• ASC -默认
• DESC
• limit

(整数）显示书签的最大数目。默认值为-1 （所有书签）。
before

(字符串）放置在每个书签之前的文本。默认值为<li>.

after

(字符串）放置后每个书签的文本。默认值为</li>.

link_before
(字符串）每个书签、 超链接代码内的文本之前放置文本。没有设置的默认值。

link_afte

r(字符串）每个书签的文本后放置文本。没有设置的默认值。（此参数添加了与版本 2.7)之间(字符串）每个书签/图像和它的描述之间放置文本。默认值为'\n' （换行符）。

show_images
(布尔)应为书签的图像显示 (TRUE) 还是不 (FAUSE).

• 1(True)-默认
• 0( False)

show_description
(布尔)描述应显示或不显示 (TRUE) (FALSE)。Show_images是虚假的或未定义图像时有效。

• 1（True）
• 0(False)-默认

show_name
(布尔)显示链接的文本时 (TRUE)。当为TRUE时show_images的作品。（此参数添加了与版本 2.7)

• 1（True）
• 0(False)-默认

show_rating
(布尔)应评级星星/字符显示或不显示 (TRUE) (FAUSE).

• 1（True）
• 0(False)-默认

show_updated
(布尔)上次更新时间戳应显示或不显示 (TRUE) (FALSE)。
请注意，link_updated 不会跟踪的本地修改。它跟踪链接无论指向 pingomatic 的远程请求通过更新时。

• 1（True）
• 0(False)-默认

hide_invisible
(布尔)应书签显示即使有可见的设置是号管理员设置 (TRUE) 遵守或不会没有遵守管理设置 （FAUSE).

• 1(True)-默认
• 0( False)

echo
(布尔)显示书签 (TRUE) 或返回他们使用 php (FAUSE).

• 1(True)-默认
• 0(False)

【使用示例】

简单的列表
显示”链接”的标题和裹在

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

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

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

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

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