wp_list_bookmarks()函數(shù)是比較常用的WordPress函數(shù),特別是在我們想要調(diào)用友情鏈接時(shí),就肯定用的到了。
語(yǔ)法
<? php?wp_list_bookmarks(?$args?);??>
參數(shù)
<?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>' ); ?>
默認(rèn)情況下(沒(méi)有添加任何參數(shù))的用法:
wp_list_bookmarks()參數(shù)詳解
categorize
(布爾型)是否所有鏈接都應(yīng)該顯示在相應(yīng)的分類(lèi)目錄下。
category
(字符串)將要顯示的鏈接分類(lèi)目錄的ID,用逗號(hào)隔開(kāi)。如果沒(méi)有指定分類(lèi),顯示所有含有鏈接的鏈接分類(lèi)。
exclude_category
(字符串)將被排除的鏈接分類(lèi)目錄的ID,用逗號(hào)隔開(kāi)。默認(rèn)值為 (no categories excluded)(不排除任何鏈接分類(lèi))。
category_name
(字符串)將要顯示的鏈接所屬分類(lèi)的名稱(chēng)。如果沒(méi)有指定分類(lèi),顯示所有含有鏈接的鏈接分類(lèi)。默認(rèn)值為 (all Categories)(所有鏈接)。
category_before
(字符串)放置在每個(gè)鏈接分類(lèi)目錄前的文本。默認(rèn)值為'<li id=”[category id] ” class=”linkcat”>’。
category_after
(字符串)放置在鏈接分類(lèi)目錄后的文本。默認(rèn)值為'<‘/li>’。
class
(字符串)鏈接分類(lèi)列表所在類(lèi)。默認(rèn)值為’linkcat’。
category_orderby
(字符串)用以排列鏈接分類(lèi)的值。有效值包括:
category_order
(字符串)排列的順序,以升序或降序排列category_orderby參數(shù)值。有效值包括:
title_li
(字符串)鏈接列表的標(biāo)題。默認(rèn)值為 ‘__(‘Bookmarks’)’,顯示標(biāo)題為“Bookmarks”(the_(‘ ‘)用于本地化。)只有將categorize設(shè)為0(false)時(shí),才可使用該參數(shù)(否則將使用分類(lèi)名稱(chēng))。若將title_li設(shè)為空(0),則不顯示列表標(biāo)題,且鏈接列表不會(huì)被 <ul>, </ul>標(biāo)簽圍繞(要確保將categorize選項(xiàng)設(shè)為0,以使title_li生效)。
title_before
(字符串)’categorize’值為1(true)時(shí)顯示在每個(gè)鏈接類(lèi)別前的文本,或’categorize’值為0(false)時(shí)在’title_li’中定義的文本。 默認(rèn)值為'<h2>’。
title_after
‘categorize’值為1(true)時(shí)顯示在每個(gè)鏈接類(lèi)別后的文本,或’categorize’值為0(false)時(shí)在’title_li’中定義的文本。 默認(rèn)值為'</h2>’。
show_private
(布爾型)是否應(yīng)顯示某個(gè)鏈接分類(lèi)(即使該分類(lèi)被認(rèn)為是私密的)。忽略管理面板的設(shè)置,顯示私密鏈接分類(lèi)(TRUE),或者不顯示私密鏈接分類(lèi)(FALSE)。
include
(字符串)在結(jié)果中包含的數(shù)值型鏈接ID列表,各ID用逗號(hào)隔開(kāi)。例如, ‘include=1,3,6’ 表示返回或響應(yīng)ID為1、3、6的鏈接。如果使用include字符串,那么 category、category_name、exclude參數(shù)將被忽略。默認(rèn)值為 (all Bookmarks)(所有鏈接)。
exclude
(字符串)將要被排除的鏈接的ID,各ID用逗號(hào)隔開(kāi)。如 ‘exclude=4,12’表示不返回ID為4和12的鏈接。默認(rèn)值為 (exclude nothing)(不排除任何鏈接)。
orderby
(字符串)以何順序?yàn)殒溄优判?。這可能是一份各個(gè)值的列表,各值由逗號(hào)隔開(kāi)。默認(rèn)值為’name’,除非你傳遞’ ‘(空)值給該參數(shù),此時(shí)參數(shù)值為’id’。有效值包括:
order
(字符串)根據(jù)’orderby’參數(shù)中的設(shè)置為分類(lèi)目錄排序(升序或降序)。有效值包括:
limit
(整數(shù))可以顯示的最大鏈接數(shù)。默認(rèn)值為-1(所有鏈接)。
before
(字符串)放置在鏈接前的文本。默認(rèn)值為'<li>’。
after
(字符串)放置在鏈接后的文本。默認(rèn)值為'</li>’。
link_before
(字符串)超鏈接代碼中鏈接文本前的文字。無(wú)默認(rèn)值。
link_after
(字符串)超鏈接代碼中鏈接文本后的文字。無(wú)默認(rèn)值。
between
(字符串)鏈接/圖片與其說(shuō)明之間的文本。默認(rèn)值為’n’(換行)。
show_images
(布爾型)是(TRUE)否(FALSE)顯示鏈接的圖片
show_description
(布爾型)是(TRUE)否(FALSE)顯示鏈接說(shuō)明。該參數(shù)用于show_images為FALSE時(shí)或未定義鏈接圖片時(shí)。
show_name
(布爾型)顯示鏈接文本(TRUE)。該參數(shù)用于show_images為T(mén)RUE時(shí)。
show_rating
(字符串)是(TRUE)否(FALSE)顯示鏈接的級(jí)別。
show_updated
(布爾型)是(TRUE)否(FALSE)顯示最近更新的時(shí)間標(biāo)記。
hide_invisible
(布爾型)是否顯示公開(kāi)度為“不公開(kāi)”的鏈接。是(TRUE)否(FALSE)遵循管理面板中的設(shè)置。
echo
(布爾型)顯示結(jié)果(TRUE),或?qū)⒔Y(jié)果保留以供PHP使用(FALSE)。
實(shí)例
簡(jiǎn)單的鏈接列表
顯示所有鏈接,標(biāo)題為“Bookmarks”,各鏈接項(xiàng)包圍在<li>標(biāo)簽中,標(biāo)題則用<h2>標(biāo)簽。
<?php wp_list_bookmarks('title_li=&category_before=&category_after='); ?>
沒(méi)有標(biāo)題的簡(jiǎn)單列表
按上一個(gè)例子的條件顯示所有鏈接,但不包括默認(rèn)標(biāo)題。
<?php wp_list_bookmarks('title_li=&categorize=0'); ?>
顯示某個(gè)分類(lèi)下的所有鏈接
顯示ID為2的鏈接分類(lèi)下的所有鏈接,使用鏈接圖片,不顯示鏈接說(shuō)明,按URL排列鏈接。
<?php wp_list_bookmarks('categorize=0&category=2&before=<span>&after=</span>&show_images=1&show_description=0&orderby=url'); ?>
顯示鏈接等級(jí)和時(shí)間標(biāo)記
以數(shù)字編號(hào)列表形式顯示所有鏈接,各鏈接下另起一行填寫(xiě)鏈接說(shuō)明,不適用鏈接圖片,按ID排列鏈接,顯示鏈接等級(jí)和最新更新的時(shí)間。
<ol>
<?php wp_list_bookmarks('between=<br />&show_images=0&orderby=id&show_rating=1&show_updated=1'); ?>
</ol>
用圖片取代標(biāo)題
從主題目錄中選擇一個(gè)圖片代替普通文本作為鏈接列表標(biāo)題。
<?php wp_list_bookmarks('categorize=0&title_before=&title_after=&title_li=<img src="/uploads/img/'.get_bloginfo("stylesheet_directory").'/images/blogroll.gif" alt="blogroll" />'); ?>