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

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

「テンプレートタグ/wp list bookmarks」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Template Tags/wp_list_bookmarks 2007年8月8日 (水) 20:49 FireMind 版)
 
(関連項目)
 
(4人の利用者による、間の9版が非表示)
1行目: 1行目:
{{draft}}
+
<div id="Description">
 +
== 説明 ==
 +
</div>
 +
この関数は[[管理画面]] > [[管理パネル/リンク|リンク]] パネルにあるブックマークを表示するものです。この[[Template Tags|テンプレートタグ]]はブックマークの配列と表示をコントロールさせるものです。
  
== Description ==
+
'''NOTE''': [[Template_Tags/get_links_list|get_links_list()]] [[Template_Tags/get_links|get_links()]] が非推奨となり、 '''wp_list_bookmarks()''' がそれらの後継となりました。
This function will be found in WordPress v2.1 it is NOT supported by WordPress v2.0. [[Template_Tags/wp_list_bookmarks|wp_list_bookmarks()]], displays bookmarks found in the [[Administration_Panels|Administration]] > [[Administration_Panels#Manage_Blogroll|Blogroll]] > [[Manage_Blogroll_SubPanel|Manage Blogroll]] panel.  This [[Template_Tags|Template Tag]] allows the user to control how the bookmarks are sorted and displayed and is intended to replace the Template tags '[[Template_Tags/get_links_list|get_links_list()]]' and '[[Template_Tags/get_links|get_links()]]'.
+
  
== Usage ==
+
<div id="Usage">
%%% <?php wp_list_bookmarks('arguments'); ?> %%%
+
== 使い方 ==
 +
</div>
 +
<?php wp_list_bookmarks( $args ); ?>
  
== Examples ==
+
<div id="Default_Usage">
 +
=== 初期設定での使い方 ===
 +
</div>
 +
<pre><?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>' ); ?> </pre>
  
===Default Usage===
+
デフォルトではこの関数は以下を表示します:
<pre>
+
* カテゴリー名の見出しごとに分けられたブックマーク
$defaults = array('orderby' => 'name', 'order' => 'ASC', 'limit' => -1, 'category' => '',
+
* カテゴリー名や ID に関係しない、全てのブックマーク
  '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>');</pre>
+
* ブックマークの説明を表示
 +
* 評価の非表示
 +
* 上限が設定されない限り、全てのブックマークを表示
 +
* ブックマークの表示
  
By default, the usage shows:
+
<div id="Parameters">
* Bookmarks divided into Categories with a Category name heading
+
== パラメータ ==
* All bookmarks included, regardless of Category ID, Category Name, or Category ID
+
</div>
* Sorts the list by name
+
; categorize : (''真偽値'') ブックマークをカテゴリー内に表示させるか否か。
* An image if one is included
+
:* <tt>1</tt> (True) - デフォルト
* A space between the image and the text
+
:* <tt>0</tt> (False)
* Shows the description of the bookmark
+
* Does not show the ratings
+
* Unless limit is set, shows all bookmarks
+
* Displays bookmarks
+
  
<?php wp_list_bookmarks(); ?>
+
; category : (''文字列'') コンマで区切られた数字のカテゴリーの ID リストが表示される。もし特定されていない場合、ブックマークがある全てのカテゴリーが表示される。デフォルトは <tt><nowiki>''</nowiki></tt> (全てのカテゴリー)。
  
=== Specific Category Sorted by URL ===
+
; exclude_category : (''文字列'') コンマで区切られた数字のカテゴリーの ID リストが表示されない。デフォルトは <tt><nowiki>''</nowiki></tt> (全てのカテゴリー)。
Displays bookmarks for Category ID 2 in span tags, uses images for bookmarks, does not show descriptions, sorts by bookmark URL.
+
  
<?php wp_list_bookmarks('categorize=0&category=2&before=&lt;span&gt;&after=&lt;/span&gt;&show_images=1&show_description=0&orderby=url'); ?>
+
; category_name : (''文字列'') 表示されるブックマークのカテゴリーの名前。もし特定されていない場合、ブックマークがある全てのカテゴリーが表示される。デフォルトは <tt><nowiki>''</nowiki></tt> (全てのカテゴリー)。
  
=== Shows Ratings and Timestamp ===
+
; category_before : (''文字列'') 各カテゴリーの前につけるテキスト。デフォルトは、 <tt>'&lt;li id="[category id]" class="linkcat"&gt;'</tt> 。
Displays all bookmarks in an ordered list with descriptions on a new line, does not use images for bookmarks, sorts by bookmark id, shows ratings and last-updated timestamp.
+
  
&lt;ol&gt;
+
; category_after : (''文字列'') 各カテゴリーの後につけるテキスト。デフォルトは、 <tt>'&lt;/li&gt;'</tt> 。
<?php wp_list_bookmarks('between=&lt;br /&gt;&show_images=0&orderby=id&show_rating=1&show_updated=1'); ?>
+
&lt;/ol&gt;
+
  
== Parameters ==
+
; class : (''文字列'') 各カテゴリーに割り当てられる class 。デフォルトは <tt>'linkcat'</tt> (このパラメーターは [[Version 2.2]] にて追加されました)
<!--
+
 
<pre>
+
; category_orderby : (''文字列'') カテゴリーを並べる値。有効なオプションは:
Default settings for actual function will be deleted upon publication
+
:* <tt>'name'</tt> - デフォルト
$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>');
+
</pre>
+
-->
+
; categorize : (''boolean'') Bookmarks should be shown within their assigned Categories (<tt>TRUE</tt>) or not (<tt>FALSE</tt>). Defaults to <tt>TRUE</tt>.
+
:* <tt>1</tt> (True - default)
+
:* <tt>0</tt> (False)
+
; category : (''string'') Comma separated list of numeric Category IDs to be displayed. If none is specified, all Categories with bookmarks are shown. Defaults to <tt>''</tt> (all Categories).
+
; category_name : (''string'') The name of a Category whose bookmarks will be displayed. If none is specified, all Categories with bookmarks are shown. Defaults to <tt>''</tt> (all Categories).
+
; category_orderby : (''string'') Value to sort Categories on. Defaults to <tt>'name'</tt>. Valid options:
+
:* <tt>'name'</tt> (Default)
+
 
:* <tt>'id'</tt>
 
:* <tt>'id'</tt>
; category_order : (''string'') Sort order, ascending or descending for the category_orderby parameter. Valid values:
+
:* <tt>'slug'</tt>
:* <tt>ASC</tt> (Default)
+
:* <tt>'count'</tt>
:* <tt>DESC</tt>
+
:* <tt>'term_group'</tt> (まだ使われていない)
; title_li : (''string'') Text for the heading of the Page list. Defaults to <tt>'__('Bookmarks')'</tt>, which displays "Bookmarks" (the <tt>__(&#039;&#039;)</tt> is used for [[Localization|localization purposes]]).  Only used with categorize set to 0 (else the category names will be used instead). If passed a null or empty value (<tt>&#039;&#039;</tt>), no heading is displayed, and the list will not be wrapped with <tt>&lt;ul>, &lt;/ul></tt> tags.
+
 
; title_before : (''string'') Text to place before each Category description if 'categorize' is TRUE.  Defaults to <tt>'&lt;h2&gt;'</tt>.
+
; category_order : (''文字列'') 上記、 category_orderby の並べる順を昇順か降順か決めるもの。有効なオプションは:
; title_after : (''string'') Text to place after each Category description if 'categorize' is TRUE. Defaults to <tt>'&lt;/h2&gt;'</tt>.
+
:* <tt>ASC (昇順)</tt> - デフォルト
; show_private : (''boolean'') Should a Category be displayed even if the Category is considered private.  Ignore the admin setting and show private Categories (<tt>TRUE</tt>) or do NOT show private Categories (<tt>FALSE</tt>). Defaults to <tt>FALSE</tt>.
+
:* <tt>DESC (降順)</tt>
 +
 
 +
; title_li : (''文字列'') リンクリストの見出しテキスト。デフォルトは <tt>'__('Bookmarks')'</tt> で、 "Bookmarks" と表示される (これは[[Localization|ローカライゼーションのため]]に <tt>__(&#039;&#039;)</tt> が用いられる)。 'categorize' が 0 [false] の時のみ用いられ、その他の場合はカテゴリー名が用いられる。もし 'title_li' が null (0) であった場合、見出しは表示されず、リストは <tt>&lt;ul>, &lt;/ul></tt> タグでラップされない。このオプションを有効化させるためには、 'categorize' オプションが 0 [false] であることを確認すること。
 +
 
 +
; title_before : (''文字列'') 'categorize' が 1 [true] の時は、各カテゴリー説明の前に付けるテキスト。 'categorize' が 0 [false] の時は、 "title_li" で定義されたもの。デフォルトは <tt>'&lt;h2&gt;'</tt>
 +
 
 +
; title_after : (''文字列'') 'categorize' が 1 [true] の時は、各カテゴリー説明の後に付けるテキスト。 'categorize' が 0 [false] の時は、 "title_li" で定義されたもの。デフォルトは <tt>'&lt;/h2&gt;'</tt>
 +
 
 +
; show_private : (''真偽値'') カテゴリーがプライベートであったとしても表示させるか否かを決める値。メインの設定を無視して、プライベートなカテゴリーでも表示させる (<tt>TRUE</tt>) または、表示させない (<tt>FALSE</tt>)
 
:* <tt>1</tt> (True)
 
:* <tt>1</tt> (True)
:* <tt>0</tt> (False - default)
+
:* <tt>0</tt> (False) - デフォルト
; 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 <tt>''</tt> (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 <tt>''</tt> (exclude nothing).
+
; include : (''文字列'') 出力するブックマークの ID 数字リストをコンマで区切ったもの。例えば、 'include=1,3,6' は、ブックマーク ID の 1, 3, 6 を出力する。もし文字列が使われた場合、 ''category'', ''category_name'', ''exclude'' のパラメーターは無視される。デフォルトは <tt><nowiki>''</nowiki></tt> (全てのブックマーク)
; orderby : (''string'') Value to sort bookmarks on. Defaults to <tt>'name'</tt> unless you pass the value of <tt>&#39;&#39;</tt> (empty), in which case it sets to <tt>'id'</tt>. Valid options:
+
 
:* <tt>'id'</tt>
+
; exclude : (''文字列'') 出力しないブックマークの ID 数字リストをコンマで区切ったもの。例えば、 'exclude=4,12' は、ブックマーク ID が 4 12 を返さず、出力もしない。デフォルトは <tt><nowiki>''</nowiki></tt> (出力しないものはない → 全てのブックマークを表示)
 +
 
 +
; orderby : (''文字列'') ブックマークを並べる順番の値。コンマで区切られた値のリストも受け入れることが可能である。 <tt>'id'</tt> としてセットする <tt>&#39;&#39;</tt> () の値を渡さない限り、デフォルトは <tt>'name'</tt> である。有効なオプションは:
 +
:* <tt>'link_id'</tt> - WordPress 3.2 以前では: <tt>'id'</tt>
 
:* <tt>'url'</tt>
 
:* <tt>'url'</tt>
:* <tt>'name'</tt>
+
:* <tt>'name'</tt> - デフォルト
 
:* <tt>'target'</tt>
 
:* <tt>'target'</tt>
 
:* <tt>'description'</tt>
 
:* <tt>'description'</tt>
:* <tt>'owner'</tt> - User who added bookmark through bookmarks Manager.
+
:* <tt>'owner'</tt> - ブックマークマネージャーを通してそれを追加したユーザー。
 
:* <tt>'rating'</tt>
 
:* <tt>'rating'</tt>
:* <tt>'updated'</tt>
+
:* <tt>'updated'</tt> Note: link_updated フィールドはローカルでの更新をトラックするものではありません。これは Pingomatic へのリモートリクエストを経て、リンク先のアップデートをトラックするものです。
:* <tt>'rel'</tt> - bookmark relationship (XFN).
+
:* <tt>'rel'</tt> - ブックマークの関係 (XFN).
 
:* <tt>'notes'</tt>
 
:* <tt>'notes'</tt>
 
:* <tt>'rss'</tt>
 
:* <tt>'rss'</tt>
:* <tt>'length'</tt> - The length of the bookmark name, shortest to longest. 
+
:* <tt>'length'</tt> - ブックマーク名。短い順。
:* <tt>'rand'</tt> - Display bookmarks in random order. 
+
:* <tt>'rand'</tt> - ブックマークをランダムな順に表示する。
  
; order : (''string'') Sort order, ascending or descending for the orderby parameter. Valid values:
+
; order : (''文字列'') 上記、 'orderly' パラメーターの値を昇順か降順か決める。有効な値は:
:* <tt>ASC</tt> (Default)
+
:* <tt>ASC (昇順)</tt> - デフォルト
:* <tt>DESC</tt>
+
:* <tt>DESC (降順)</tt>
; limit : (''integer'') Maximum number of bookmarks to display. Defaults to <tt>-1</tt> (all bookmarks).
+
 
; before : (''string'') Text to place before each bookmark. Defaults to <tt>'&lt;li&gt;'</tt>.
+
; limit : (''integer'') 表示させるブックマークの最大数。デフォルトは <tt>-1</tt> (全て表示)
; after : (''string'') Text to place after each bookmark. Defaults to <tt>'&lt;/li&gt;'</tt>.
+
 
; category_before : (''string'') Text to place before each category. Defaults to <tt>'&lt;li&gt;'</tt> with an appropriate id and class.
+
; before : (''文字列'') 各ブックマークの前につけるテキスト。デフォルトは、 <tt>'&lt;li&gt;'</tt>
; category_after : (''string'') Text to place after each category. Defaults to <tt>'&lt;/li&gt;'</tt>.
+
 
; between : (''string'') Text to place between each bookmark/image and its description. Defaults to <tt>'\n'</tt> (newline).
+
; after : (''文字列'') 各ブックマークの後につけるテキスト。デフォルトは、 <tt>'&lt;/li&gt;'</tt>
; show_images : (''boolean'') Should images for bookmarks be shown (<tt>TRUE</tt>) or not (<tt>FALSE</tt>). Defaults to <tt>TRUE</tt>.
+
 
:* <tt>1</tt> (True - default)
+
;link_before : (''文字列'') 各ブックマークのハイパーリンクコードの前につけるテキスト。デフォルトはない。 (このパラメーターは [[Version 2.7]] にて追加されました。)
 +
 
 +
;link_after : (''文字列'') 各ブックマークのハイパーリンクコードの後につけるテキスト。デフォルトはない。 (このパラメーターは [[Version 2.7]] にて追加されました。)
 +
 
 +
; between : (''文字列'') 各ブックマークまたは画像と、その説明の間に入れるテキスト。デフォルトは <tt>'\n'</tt> (改行)
 +
 
 +
; show_images : (''真偽値'') ブックマークの画像を表示する (<tt>TRUE</tt>) または表示しない (<tt>FALSE</tt>)
 +
:* <tt>1</tt> (True) - デフォルト
 
:* <tt>0</tt> (False)
 
:* <tt>0</tt> (False)
; show_description : (''boolean'') Should the description be displayed (<tt>TRUE</tt>) or not (<tt>FALSE</tt>). Valid when '''show_images''' is <tt>FALSE</tt>, or an image is not defined. Defaults to <tt>FALSE</tt>.
+
 
 +
; show_description : (''真偽値'') ブックマークの説明を表示する (<tt>TRUE</tt>) または表示しない (<tt>FALSE</tt>)'''show_images''' <tt>FALSE</tt> または画像が定義されていない時に有効となる。
 
:* <tt>1</tt> (True)
 
:* <tt>1</tt> (True)
:* <tt>0</tt> (False - default)
+
:* <tt>0</tt> (False) - デフォルト
; show_rating : (''boolean'') Should rating stars/characters be displayed (<tt>TRUE</tt>) or not (<tt>FALSE</tt>). Defaults to <tt>FALSE</tt>.
+
 
 +
; show_name : (''真偽値'') リンクのテキストを表示する (<tt>TRUE</tt>) 。 '''show_images''' が <tt>TRUE</tt> である時に有効となる。 (このパラメーターは [[Version 2.7]] にて追加されました。)
 
:* <tt>1</tt> (True)
 
:* <tt>1</tt> (True)
:* <tt>0</tt> (False - default)
+
:* <tt>0</tt> (False) - デフォルト
; show_updated : (''boolean'') Should the last updated timestamp be displayed (<tt>TRUE</tt>) or not (<tt>FALSE</tt>). Defaults to <tt>FALSE</tt>.
+
 
 +
; show_rating : (''真偽値'') 評価の星または文字を表示する (<tt>TRUE</tt>) または表示しない (<tt>FALSE</tt>)
 
:* <tt>1</tt> (True)
 
:* <tt>1</tt> (True)
:* <tt>0</tt> (False - default)
+
:* <tt>0</tt> (False) - デフォルト
; hide_invisible : (''boolean'') Should bookmark be displayed even if it's Visible setting is No.  Abides by admin setting (<tt>TRUE</tt>) or does no abide by admin setting (<tt>FALSE</tt>). Defaults to <tt>TRUE</tt>.
+
 
:* <tt>1</tt> (True - default)
+
; show_updated : (''真偽値'') 最終更新のタイムスタンプを表示する (<tt>TRUE</tt>) または表示しない (<tt>FALSE</tt>)。 link_updated フィールドはローカルでの更新をトラックするものではありません。これは Pingomatic へのリモートリクエストを経て、リンク先のアップデートをトラックするものです。
 +
:* <tt>1</tt> (True)
 +
:* <tt>0</tt> (False) - デフォルト
 +
 
 +
; hide_invisible : (''真偽値'')  
 +
ブックマークを後悔しない設定にしていたとしても表示させる。 (<tt>TRUE</tt>) または、表示させない (<tt>FALSE</tt>) 。管理者設定に従う (<tt>TRUE</tt>) または、従わない (<tt>FALSE</tt>) 。
 +
:* <tt>1</tt> (True) - デフォルト
 
:* <tt>0</tt> (False)
 
:* <tt>0</tt> (False)
; echo : (''boolean'') Display bookmarks (<tt>TRUE</tt>) or return them for use by PHP (<tt>FALSE</tt>). Defaults to <tt>TRUE</tt>.
+
 
:* <tt>1</tt> (True - default)
+
; echo : (''真偽値'') ブックマークを表示させる (<tt>TRUE</tt>) または PHP で使うために返す (<tt>FALSE</tt>)
 +
:* <tt>1</tt> (True) - デフォルト
 
:* <tt>0</tt> (False)
 
:* <tt>0</tt> (False)
  
== Related ==
+
<div id="Examples">
 +
== 使用例 ==
 +
</div>
 +
<div id="Simple_List">
 +
=== シンプルリスト ===
 +
</div>
 +
全てのブックマークを "Bookmarks" というタイトルで、 &lt;li&gt; タグで囲んだ状態で表示させる。タイトルは &lt;h2&gt; タグで囲まれる。
 +
<?php wp_list_bookmarks('title_li=&category_before=&category_after='); ?>
 +
 
 +
<div id="Simple_List_without_the_Heading">
 +
=== 見出しなしのシンプルリスト ===
 +
</div>
 +
全てのブックマークをデフォルトの見出し抜きで、あとは上記と同様に表示させる。
 +
<?php wp_list_bookmarks('title_li=&categorize=0'); ?>
 +
 
 +
<div id="Specific_Category_Sorted_by_URL">
 +
=== URL でソートされた特定のカテゴリー ===
 +
</div>
 +
カテゴリー ID 2 のブックマークを span タグ内に表示し、画像を用いるが、説明を表示させず、 URL 順に並べる。
 +
<?php wp_list_bookmarks('categorize=0&category=2&before=&lt;span&gt;&after=&lt;/span&gt;&show_images=1&show_description=0&orderby=url'); ?>
 +
 
 +
<div id="Shows Ratings and Timestamp">
 +
=== 評価とタイムスタンプを表示 ===
 +
</div>
 +
全てのブックマークを番号付きリストで表示させ、説明を別の行に、イメージを用いず、ブックマーク ID 順で並べ、評価と最終更新のタイムスタンプを表示させる。 (最終更新のタイムスタンプはローカルでの更新をトラックするものではありません。 Pingomatic へのリモートリクエストを経て、リンク先のアップデートをトラックするものです)
 +
 
 +
&lt;ol&gt;
 +
<?php wp_list_bookmarks('between=&lt;br /&gt;&show_images=0&orderby=id&show_rating=1&show_updated=1'); ?>
 +
&lt;/ol&gt;
 +
 
 +
<div id="Replaces Heading with Image">
 +
=== 見出しを画像に置き換え ===
 +
</div>
 +
テキストの代わりにテーマフォルダからの画像を用いる。
 +
<?php wp_list_bookmarks('categorize=0&title_before=&title_after=&title_li=<img src="'.get_bloginfo("stylesheet_directory").'/images/blogroll.gif" alt="blogroll" />'); ?>
 +
 
 +
<div id="Change Log">
 +
== 改訂履歴 ==
 +
</div>
 +
* [[Version 2.7]] : <code>link_before</code>, <code>link_after</code>, <code>show_name</code> のパラメーターを追加。
 +
* [[Version 2.2]] : <code>class</code> パラメーターを追加。
 +
* [[Version 2.1]] : 導入。
 +
 
 +
<div id="Source File">
 +
== ソースファイル ==
 +
</div>
 +
<tt>wp_list_bookmarks()</tt> は {{Trac|wp-includes/bookmark-template.php}} にあります。
 +
 
 +
<div id="Related">
 +
== 関連項目 ==
 +
</div>
 +
{{Bookmark Tags}}
  
{{Tag bookmark Manager Tags}}
+
{{Lists Tags}}
  
{{PHP Function Tag Footer}}
+
{{Tag Footer}}
  
[[Category:Drafts]]
+
{{原文|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_imagesFALSE または画像が定義されていない時に有効となる。
  • 1 (True)
  • 0 (False) - デフォルト
show_name 
(真偽値) リンクのテキストを表示する (TRUE) 。 show_imagesTRUE である時に有効となる。 (このパラメーターは 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" />'); ?>

改訂履歴

ソースファイル

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最新版との差分