- 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。（詳細）
「テンプレートタグ/wp list bookmarks」の版間の差分
提供: WordPress Codex 日本語版
< テンプレートタグ
(翻訳全面見直し。19:38, February 11, 2014 Djkaz 版) |
細 (→関連項目) |
||
| 200行目: | 200行目: | ||
== 関連項目 == | == 関連項目 == | ||
</div> | </div> | ||
| − | |||
| − | |||
| − | |||
| − | |||
{{Bookmark Tags}} | {{Bookmark Tags}} | ||
| 210行目: | 206行目: | ||
{{Tag Footer}} | {{Tag Footer}} | ||
| − | + | {{原文|Function Reference/wp list bookmarks|141173}}<!-- 19:38, February 11, 2014 Djkaz 版 --> | |
2015年5月23日 (土) 00:15時点における最新版
目次
説明
この関数は管理画面 > リンク パネルにあるブックマークを表示するものです。このテンプレートタグはブックマークの配列と表示をコントロールさせるものです。
NOTE: get_links_list() と get_links() が非推奨となり、 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>' ); ?>
デフォルトではこの関数は以下を表示します:
- カテゴリー名の見出しごとに分けられたブックマーク
- カテゴリー名や ID に関係しない、全てのブックマーク
- 含まれている場合は画像
- 名前で並べ替えられたリスト
- 画像とテキストの間のスペース
- ブックマークの説明を表示
- 評価の非表示
- 上限が設定されない限り、全てのブックマークを表示
- ブックマークの表示
パラメータ
- categorize
- (真偽値) ブックマークをカテゴリー内に表示させるか否か。
- 1 (True) - デフォルト
- 0 (False)
- category
- (文字列) コンマで区切られた数字のカテゴリーの ID リストが表示される。もし特定されていない場合、ブックマークがある全てのカテゴリーが表示される。デフォルトは '' (全てのカテゴリー)。
- exclude_category
- (文字列) コンマで区切られた数字のカテゴリーの ID リストが表示されない。デフォルトは '' (全てのカテゴリー)。
- category_name
- (文字列) 表示されるブックマークのカテゴリーの名前。もし特定されていない場合、ブックマークがある全てのカテゴリーが表示される。デフォルトは '' (全てのカテゴリー)。
- category_before
- (文字列) 各カテゴリーの前につけるテキスト。デフォルトは、 '<li id="[category id]" class="linkcat">' 。
- category_after
- (文字列) 各カテゴリーの後につけるテキスト。デフォルトは、 '</li>' 。
- class
- (文字列) 各カテゴリーに割り当てられる class 。デフォルトは 'linkcat' 。 (このパラメーターは Version 2.2 にて追加されました)
- category_orderby
- (文字列) カテゴリーを並べる値。有効なオプションは:
- 'name' - デフォルト
- 'id'
- 'slug'
- 'count'
- 'term_group' (まだ使われていない)
- category_order
- (文字列) 上記、 category_orderby の並べる順を昇順か降順か決めるもの。有効なオプションは:
- ASC (昇順) - デフォルト
- DESC (降順)
- title_li
- (文字列) リンクリストの見出しテキスト。デフォルトは '__('Bookmarks')' で、 "Bookmarks" と表示される (これはローカライゼーションのために __('') が用いられる)。 'categorize' が 0 [false] の時のみ用いられ、その他の場合はカテゴリー名が用いられる。もし 'title_li' が null (0) であった場合、見出しは表示されず、リストは <ul>, </ul> タグでラップされない。このオプションを有効化させるためには、 'categorize' オプションが 0 [false] であることを確認すること。
- title_before
- (文字列) 'categorize' が 1 [true] の時は、各カテゴリー説明の前に付けるテキスト。 'categorize' が 0 [false] の時は、 "title_li" で定義されたもの。デフォルトは '<h2>' 。
- title_after
- (文字列) 'categorize' が 1 [true] の時は、各カテゴリー説明の後に付けるテキスト。 'categorize' が 0 [false] の時は、 "title_li" で定義されたもの。デフォルトは '</h2>' 。
- show_private
- (真偽値) カテゴリーがプライベートであったとしても表示させるか否かを決める値。メインの設定を無視して、プライベートなカテゴリーでも表示させる (TRUE) または、表示させない (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' である。有効なオプションは:
- 'link_id' - WordPress 3.2 以前では: 'id'
- 'url'
- 'name' - デフォルト
- 'target'
- 'description'
- 'owner' - ブックマークマネージャーを通してそれを追加したユーザー。
- 'rating'
- 'updated' Note: link_updated フィールドはローカルでの更新をトラックするものではありません。これは Pingomatic へのリモートリクエストを経て、リンク先のアップデートをトラックするものです。
- 'rel' - ブックマークの関係 (XFN).
- 'notes'
- 'rss'
- 'length' - ブックマーク名。短い順。
- 'rand' - ブックマークをランダムな順に表示する。
- order
- (文字列) 上記、 'orderly' パラメーターの値を昇順か降順か決める。有効な値は:
- ASC (昇順) - デフォルト
- DESC (降順)
- limit
- (integer) 表示させるブックマークの最大数。デフォルトは -1 (全て表示)
- before
- (文字列) 各ブックマークの前につけるテキスト。デフォルトは、 '<li>' 。
- after
- (文字列) 各ブックマークの後につけるテキスト。デフォルトは、 '</li>' 。
- link_before
- (文字列) 各ブックマークのハイパーリンクコードの前につけるテキスト。デフォルトはない。 (このパラメーターは Version 2.7 にて追加されました。)
- link_after
- (文字列) 各ブックマークのハイパーリンクコードの後につけるテキスト。デフォルトはない。 (このパラメーターは Version 2.7 にて追加されました。)
- between
- (文字列) 各ブックマークまたは画像と、その説明の間に入れるテキスト。デフォルトは '\n' (改行) 。
- show_images
- (真偽値) ブックマークの画像を表示する (TRUE) または表示しない (FALSE)。
- 1 (True) - デフォルト
- 0 (False)
- show_description
- (真偽値) ブックマークの説明を表示する (TRUE) または表示しない (FALSE)。 show_images が FALSE または画像が定義されていない時に有効となる。
- 1 (True)
- 0 (False) - デフォルト
- show_name
- (真偽値) リンクのテキストを表示する (TRUE) 。 show_images が TRUE である時に有効となる。 (このパラメーターは Version 2.7 にて追加されました。)
- 1 (True)
- 0 (False) - デフォルト
- show_rating
- (真偽値) 評価の星または文字を表示する (TRUE) または表示しない (FALSE)。
- 1 (True)
- 0 (False) - デフォルト
- show_updated
- (真偽値) 最終更新のタイムスタンプを表示する (TRUE) または表示しない (FALSE)。 link_updated フィールドはローカルでの更新をトラックするものではありません。これは Pingomatic へのリモートリクエストを経て、リンク先のアップデートをトラックするものです。
- 1 (True)
- 0 (False) - デフォルト
- hide_invisible
- (真偽値)
ブックマークを後悔しない設定にしていたとしても表示させる。 (TRUE) または、表示させない (FALSE) 。管理者設定に従う (TRUE) または、従わない (FALSE) 。
- 1 (True) - デフォルト
- 0 (False)
- echo
- (真偽値) ブックマークを表示させる (TRUE) または PHP で使うために返す (FALSE) 。
- 1 (True) - デフォルト
- 0 (False)
使用例
シンプルリスト
全てのブックマークを "Bookmarks" というタイトルで、 <li> タグで囲んだ状態で表示させる。タイトルは <h2> タグで囲まれる。
<?php wp_list_bookmarks('title_li=&category_before=&category_after='); ?>
見出しなしのシンプルリスト
全てのブックマークをデフォルトの見出し抜きで、あとは上記と同様に表示させる。
<?php wp_list_bookmarks('title_li=&categorize=0'); ?>
URL でソートされた特定のカテゴリー
カテゴリー ID 2 のブックマークを span タグ内に表示し、画像を用いるが、説明を表示させず、 URL 順に並べる。
<?php wp_list_bookmarks('categorize=0&category=2&before=<span>&after=</span>&show_images=1&show_description=0&orderby=url'); ?>
評価とタイムスタンプを表示
全てのブックマークを番号付きリストで表示させ、説明を別の行に、イメージを用いず、ブックマーク ID 順で並べ、評価と最終更新のタイムスタンプを表示させる。 (最終更新のタイムスタンプはローカルでの更新をトラックするものではありません。 Pingomatic へのリモートリクエストを経て、リンク先のアップデートをトラックするものです)
<ol>
<?php wp_list_bookmarks('between=<br />&show_images=0&orderby=id&show_rating=1&show_updated=1'); ?>
</ol>
見出しを画像に置き換え
テキストの代わりにテーマフォルダからの画像を用いる。
<?php wp_list_bookmarks('categorize=0&title_before=&title_after=&title_li=<img src="'.get_bloginfo("stylesheet_directory").'/images/blogroll.gif" alt="blogroll" />'); ?>
改訂履歴
- Version 2.7 :
link_before,link_after,show_nameのパラメーターを追加。 - Version 2.2 :
classパラメーターを追加。 - Version 2.1 : 導入。
ソースファイル
wp_list_bookmarks() は wp-includes/bookmark-template.php にあります。
関連項目
ブックマークタグ: wp_list_bookmarks, get_bookmarks, get_bookmark get_bookmark_field
リスト・ドロップダウン関数： wp_list_authors(), wp_list_categories(), wp_list_pages(), wp_list_bookmarks(), wp_list_comments(), wp_get_archives(), wp_page_menu(), wp_dropdown_pages(), wp_dropdown_categories(), wp_dropdown_users()
関数リファレンス、テンプレートタグ目次もご覧ください。
最新英語版： WordPress Codex » Function Reference/wp list bookmarks （最新版との差分）
