テンプレートタグ/get bookmarks

説明

この関数は管理画面 > リンク > 編集画面にあるブックマークの配列を返すものです。このテンプレートタグはブックマークの情報を直に取得するものです。

使い方

<?php get_bookmarks( $args ); ?>

初期設定での使用

<?php $args = array(
	'orderby'        => 'name', 
	'order'          => 'ASC',
	'limit'          => -1, 
	'category'       => '',
	'category_name'  => '', 
	'hide_invisible' => 1,
	'show_updated'   => 0, 
	'include'        => '',
	'exclude'        => '',
	'search'         => '' ); ?>

By default, the usage gets:

• All bookmarks ordered by name, ascending
• Bookmarks marked as hidden are not returned.
• The link_updated_f field (the update time in the form of a timestamp) is not returned.

パラメータ

orderby 

(string) Value to sort bookmarks on. Defaults to 'name'. Valid options:

• 'link_id' - Before WordPress 3.2: 'id'
• 'url'
• 'name' - Default
• 'owner' - User who added bookmark through bookmarks Manager.
• 'rating'
• 'visible'
• 'length' - The length of the bookmark name, shortest to longest.
• 'rand' - Display bookmarks in random order.

order 

(string) Sort order, ascending or descending for the orderby parameter. Valid values:

• ASC - Default
• DESC

limit 

(integer) Maximum number of bookmarks to display. Defaults to -1 (all bookmarks).

category 

(string) Comma separated list of bookmark category ID's.

category_name 

(string) Category name of a category of bookmarks to retrieve. Overrides category parameter.

hide_invisible 

(boolean) TRUE causes only bookmarks with link_visible set to 'Y' to be retrieved.

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

show_updated 

(boolean) TRUE causes an extra column called "link_category_f" to be inserted into the results, which contains the same value as "link_updated", but in a unix timestamp format. Handy for using PHP date functions on this data.

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

include 

(string) Comma separated list of numeric bookmark IDs to include in the output. For example, 'include=1,3,6' means to return or echo bookmark IDs 1, 3, and 6. If the include string is used, the category, category_name, and exclude parameters are ignored. Defaults to (all Bookmarks).

exclude 

(string) Comma separated list of numeric bookmark IDs to exclude. For example, 'exclude=4,12' means that bookmark IDs 4 and 12 will NOT be returned or echoed. Defaults to (exclude nothing).

search 

(string) Searches link_url, link_name or link_description like the search string. Defaults to .

Return Values

(array) 

List of bookmark row objects. Each bookmark object may contain the following: 'link_id', 'link_url', 'link_name', 'link_image', 'link_target', 'link_category', 'link_description', 'link_visible', 'link_owner', 'link_rating', 'link_updated', 'link_rel', 'link_notes', 'link_rss'

使用例

- Create a link category named "Related Sites"
- Create a few links, adding them to the "Related Sites" category

You may use the following code in your templates to retrieve the links:

<?php
$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="%s">%s</a><br />', $bookmark->link_url, $bookmark->link_name );
}
?>

改訂履歴

Version 2.1 にて導入されました。

ソースファイル

get_bookmarks() は wp-includes/bookmark.php にあります。

関連項目

最新英語版： WordPress Codex » Template Tags/get_bookmarks （最新版との差分）

ブックマークタグ: wp_list_bookmarks, get_bookmarks, get_bookmark get_bookmark_field

関数リファレンス、テンプレートタグ目次もご覧ください。