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

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

テンプレートタグ/wp list bookmarks

提供: WordPress Codex 日本語版
< テンプレートタグ
2007年9月1日 (土) 21:42時点におけるBono (トーク | 投稿記録)による版 (要確認部分を除きひととおり和訳)

移動先: 案内検索

このページはラフドラフトで、まだ内容の検証が済んでいません。情報が間違っていたり書き直されることがあります。
執筆中のため、執筆者の許可なく編集しないでください

要検討このページのノートをご覧ください。

この関数は WordPress バージョン 2.1 以上で使えます。2.0.x 系には対応していません。 wp_list_bookmarks() は、管理 > ブログロール > Manage Blogroll パネルにあるブックマークを表示します。ブックマークの表示順や表示内容を指定できます。このタグは、テンプレートタグ 'get_links_list()' と 'get_links()' の後継に当たります。

使い方

<?php wp_list_bookmarks('引数'); ?>

用例

初期設定での使用

$defaults = array('orderby' => 'name', 'order' => 'ASC', 'limit' => -1, '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>');

デフォルトでは次のように表示されます。

  • ブックマークをカテゴリ毎に分け、カテゴリ名の見出しを付ける
  • All bookmarks included, regardless of Category ID, Category Name, or Category ID
  • リストを名前順にソート
  • 画像(Image URL)が登録されていれば表示
  • A space between the image and the text
  • ブックマークの概要(Description)を表示
  • 評価(Rating)は非表示
  • 表示数制限なし、全てのブックマークを表示
  • ブックマークを表示(サイトに表示するか値を返すかを選べるので)
<?php wp_list_bookmarks(); ?>

特定のカテゴリを URL でソート

<span> タグ内にカテゴリID 2 のブックマークを表示、ブックマークの画像を使用、概要は非表示、ブックマーク URL でソート。

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

評価とタイムスタンプを表示

番号付き箇条書きで全てのブックマークを表示、各ブックマークの 2行目に概要を表示、画像は非表示、ブックマークID でソート、評価・最終更新日時を表示。

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

パラメータ

categorize
真偽値) ブックマークをカテゴリ分けして表示する(TRUE)か否(FALSE)か。初期値は TRUE(カテゴリ毎に分ける)。
  • 1 (True - 初期値)
  • 0 (False)
category
文字列) 表示するカテゴリID の数字をカンマ区切りで指定。特に指定しなければ全カテゴリのブックマークを表示。初期値は ''(全カテゴリ)。
category_name
文字列) 表示するブックマークのカテゴリ名。特に指定しなければ全カテゴリのブックマークを表示。初期値は ''(全カテゴリ)。
category_orderby
文字列) カテゴリをどの項目でソートするか。初期値は 'name'。有効値:
  • 'name' (初期値)
  • 'id'
category_order
文字列) カテゴリのソート順。category_orderby パラメータで指定した項目の昇順か降順か。有効値:
  • ASC (初期値)
  • DESC
title_li
文字列) ブックマークリストの見出しとする文字列。初期値は「Bookmarks」(またはその翻訳語句)を表示するための '__('Bookmarks')'(「__('○○')」は翻訳用の書き方)。'categorize' パラメータが 0 のときにのみ有効( 1 のときは見出しにカテゴリ名が使われる)。ヌルか空の値('')を指定すると、見出しは表示せず、リストを <ul>, </ul> タグで括らない。
title_before
文字列) 'categorize' パラメータが TRUE のとき、各カテゴリ概要の前に置く文字列。初期値は '<h2>'
title_after
文字列) 'categorize' パラメータが TRUE のとき、各カテゴリ概要の後ろに置く文字列。初期値は '</h2>'
show_private
真偽値) プライベートなカテゴリであっても表示するか。管理設定を無視してプライベートカテゴリを表示する(TRUE)か、プライベートカテゴリを表示しない(FALSE)か。初期値は FALSE(表示しない)。
  • 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 のものは返さない/表示しない。初期値は ''(除外なし)。
orderby
文字列) ブックマークをどの項目でソートするか。'id' とするために ''(ブランク)を指定するのでない限り、初期値は 'name'。有効値:
  • 'id'
  • 'url'
  • 'name'
  • 'target'
  • 'description'
  • 'owner' - ブックマーク管理パネルでブックマークを追加したユーザ
  • 'rating'
  • 'updated'
  • 'rel' - ブックマーク先との続柄(bookmark relationship)(XFN).
  • 'notes'
  • 'rss'
  • 'length' - The length of the bookmark name, shortest to longest.
  • 'rand' - ランダムな順序でブックマークを表示
order
ブックマークのソート順。orderby パラメータで指定した項目の昇順か降順か。有効値:
  • ASC (初期値)
  • DESC
limit
整数) 表示するブックマークの最大数。初期値は -1(全ブックマーク)。
before
文字列) 各ブックマークの前に置く文字列。初期値は '<li>'
after
文字列) 各ブックマークの後ろに置く文字列。初期値は '</li>'
category_before
文字列) 各カテゴリの前に置く文字列。初期値は、それぞれに見合った idclass 属性付きの '<li>'
category_after
文字列) 各カテゴリの後ろに置く文字列。初期値は '</li>'
between
文字列) 各ブックマーク/画像とその概要との間に置く文字列。初期値は '\n'(HTMLコード上の改行?)。
show_images
真偽値) ブックマーク画像を表示する(TRUE)か否(FALSE)か。初期値は TRUE(表示)。
  • 1 (True - 初期値)
  • 0 (False)
show_description
真偽値) 各ブックマークの概要を表示する()か否()か。show_images パラメータが FALSE のときか、画像が定義されていないときに有効。初期値は FALSE(表示しない)。
  • 1 (True)
  • 0 (False - 初期値)
show_rating
真偽値) 各ブックマークの評価の星/文字を表示する(TRUE)か否(FALSE)か。初期値は FALSE(表示しない)。
  • 1 (True)
  • 0 (False - 初期値)
show_updated
真偽値) 各ブックマークの最終更新日時を表示する(TRUE)か否(FALSE)か。初期値は FALSE(表示しない)。
  • 1 (True)
  • 0 (False - 初期値)
hide_invisible
真偽値) Visible 設定が No のブックマークを非表示とするか。管理パネルでの設定に従う(TRUE)か、無視する(FALSE)か。初期値は TRUE(管理設定どおり。No なら非表示)。
  • 1 (True - 初期値)
  • 0 (False)
echo
真偽値) ブックマークを表示する(TRUE)か、PHP で使うために値として返す(FALSE)か。初期値は TRUE(表示)。
  • 1 (True - 初期値)
  • 0 (False)


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


テンプレートタグへの PHP 関数型パラメータの渡し方関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Template Tags/wp_list_bookmarks