• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

テンプレートタグ/get bookmarks

提供: WordPress Codex 日本語版
移動先: 案内検索

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

使い方

<?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'         => '' ); ?>

デフォルトでは、使用方法はこの値が入ります:

  • 全てのブックマークが名前の降順で並びます
  • 非公開のブックマークは戻されません
  • link_updated_f フィールド (タイムスタンプ形式の更新時間) は戻されません

パラメータ

orderby 
(文字列) ブックマークを並べる順番の値。デフォルトは 'name' 。有効なオプションは:
  • 'link_id' - WordPress 3.2 以前では: 'id'
  • 'url'
  • 'name' - デフォルト
  • 'owner' - ブックマークマネージャーを通してそれを追加したユーザー。
  • 'rating'
  • 'visible'
  • 'length' - ブックマーク名。短い順。
  • 'rand' - ブックマークをランダムな順に表示する。
order 
(文字列) 上記、 orderly パラメーターの値を昇順か降順か決める。有効な値は:
  • ASC (昇順) - デフォルト
  • DESC (降順)
limit 
(整数) 表示させるブックマークの最大数。デフォルトは -1 (全て表示)
category 
(文字列) コンマで区切られたブックマークカテゴリーの ID リスト
category_name 
(文字列) 取得するブックマークのカテゴリー名。上記 category パラメーターより優先される。
hide_invisible 
(真偽値) TRUE にすると link_visible が 'Y' であるものだけが取得される。
  • 1 (True) - デフォルト
  • 0 (False)
show_updated 
(真偽値) TRUE にすると、 "link_updated" と同じ値を UNIX のタイムスタンプフォーマットで格納する "link_category_f" が結果に追加される。これは PHP の日付機能を用いるときに便利なモノ。
  • 1 (True)
  • 0 (False) - デフォルト
include 
(文字列) 出力するブックマークの ID リストをコンマで区切ったもの。例えば、 'include=1,3,6' は、ブックマーク ID が 1, 3, 6 のものを出力する。もしこの値が使われた場合、 category, category_name, exclude のパラメーターは無視される。デフォルトは '' (全てのブックマーク)。
exclude 
(文字列) 出力しないブックマークの ID リストをコンマで区切ったもの。例えば、 'exclude=4,12' は、ブックマーク ID が 4, 12 のものを出力しない。デフォルトは '' (出力しないものはない → 全てのブックマークを表示)。
search 
(文字列) search 文字列のように、 link_url, link_name, link_description を検索する。デフォルトは ''

戻り値

(配列) 
ブックマーク列のリストオブジェクト。各ブックマークオブジェクトは以下を含む:

'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'

使用例

- "Related Sites" という名のリンクカテゴリーを作成する
- いくつかのリンクを作成し、 "Related Sites" カテゴリーに追加する

リンクを取得するためには、テンプレートに以下のコードを用いるとよい:

<?php
$bookmarks = get_bookmarks( array(
	'orderby'        => 'name',
	'order'          => 'ASC',
	'category_name'  => 'Related Sites'
));

// 各ブックマークをループし、フォーマットされた出力を表示する
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


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