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

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

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

提供: WordPress Codex 日本語版
移動先: 案内、 検索
(→‎パラメータ)
細 (→‎関連項目)
 
(他の1人の利用者による、間の3版が非表示)
1行目: 1行目:
−
{{Old||
 
−
* [[:Category:wp2.7|バージョン 2.7]] でパラメータ 'exclude_category', 'link_before', 'link_after', 'show_name' が追加されています。}}
 
−
{{NeedTrans|一部}}
 
 
<div id="Description">
 
<div id="Description">
 
== 説明 ==
 
== 説明 ==
−
</div>
+
</div>  
−
この関数は [[Version 2.1|WordPress バージョン 2.1]] 以上で使えます。2.0.x 系には対応していません。
+
この関数は[[管理画面]] > [[管理パネル/リンク|リンク]] パネルにあるブックマークを表示するものです。この[[Template Tags|テンプレートタグ]]はブックマークの配列と表示をコントロールさせるものです。
−
[[テンプレートタグ/wp_list_bookmarks|wp_list_bookmarks()]] は、[[管理パネル]] > [[管理パネル#Manage - Change your content|管理]] > [[Manage Links SubPanel|リンク]]/[[:en:Manage Links SubPanel|en]] パネルにあるブックマークを表示します。ブックマークの表示順や表示内容を指定できます。このタグは、テンプレートタグ '[[テンプレートタグ/get_links_list|get_links_list()]]' と '[[テンプレートタグ/get_links|get_links()]]' の後継に当たります。
+
 
 +
'''NOTE''': [[Template_Tags/get_links_list|get_links_list()]] と [[Template_Tags/get_links|get_links()]] が非推奨となり、 '''wp_list_bookmarks()''' がそれらの後継となりました。
  
 
<div id="Usage">
 
<div id="Usage">
 
== 使い方 ==
 
== 使い方 ==
 
</div>
 
</div>
 +
<?php wp_list_bookmarks( $args ); ?>
  
−
<?php wp_list_bookmarks('引数'); ?>
+
<div id="Default_Usage">
−
 
+
=== 初期設定での使い方 ===
−
<div id="Examples">
+
−
== 用例 ==
+
 
</div>
 
</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>
  
−
<div id="Default_Usage">
+
デフォルトではこの関数は以下を表示します:
−
=== 初期設定での使用 ===
+
* カテゴリー名の見出しごとに分けられたブックマーク
 +
* カテゴリー名や ID に関係しない、全てのブックマーク
 +
* 含まれている場合は画像
 +
* 名前で並べ替えられたリスト
 +
* 画像とテキストの間のスペース
 +
* ブックマークの説明を表示
 +
* 評価の非表示
 +
* 上限が設定されない限り、全てのブックマークを表示
 +
* ブックマークの表示
 +
 
 +
<div id="Parameters">
 +
== パラメータ ==
 
</div>
 
</div>
−
<pre>
+
; categorize : (''真偽値'') ブックマークをカテゴリー内に表示させるか否か。
−
$defaults = array(
+
:* <tt>1</tt> (True) - デフォルト
−
'orderby' => 'name',
+
:* <tt>0</tt> (False)
−
'order' => 'ASC',
+
−
'limit' => -1,
+
−
'category' => '',
+
−
'category_name' => '',
+
−
'hide_invisible' => 1,
+
−
'show_updated' => 0,
+
−
'show_description' => 1,
+
−
'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>
+
  
−
デフォルトでは次のように表示されます。
+
; category : (''文字列'') コンマで区切られた数字のカテゴリーの ID リストが表示される。もし特定されていない場合、ブックマークがある全てのカテゴリーが表示される。デフォルトは <tt><nowiki>''</nowiki></tt> (全てのカテゴリー)。
−
* ブックマークをカテゴリ毎に分け、カテゴリ名の見出しを付ける
+
−
* All bookmarks included, regardless of Category ID, Category Name, or Category ID<!-- カテゴリID・カテゴリ名を問わず、全てのブックマークを表示？ -->
+
−
* リストを名前順にソート
+
−
* 画像（Image URL）が登録されていれば表示
+
−
* A space between the image and the text<!-- 画像とテキストとの間に 1スペースを挿入？（これは between パラメータ？text とは Description か？「1スペース」で合っているか？） -->
+
−
* ブックマークの概要（Description）を表示
+
−
* 評価（Rating）は非表示
+
−
* 表示数制限なし、全てのブックマークを表示
+
−
* ブックマークを表示（サイトに表示するか値を返すかを選べるので）
+
  
−
<?php wp_list_bookmarks(); ?>
+
; exclude_category : (''文字列'') コンマで区切られた数字のカテゴリーの ID リストが表示されない。デフォルトは <tt><nowiki>''</nowiki></tt> (全てのカテゴリー)。
  
 +
; category_name : (''文字列'') 表示されるブックマークのカテゴリーの名前。もし特定されていない場合、ブックマークがある全てのカテゴリーが表示される。デフォルトは <tt><nowiki>''</nowiki></tt> (全てのカテゴリー)。
 +
 +
; category_before : (''文字列'') 各カテゴリーの前につけるテキスト。デフォルトは、 <tt>'&lt;li id="[category id]" class="linkcat"&gt;'</tt> 。
 +
 +
; category_after : (''文字列'') 各カテゴリーの後につけるテキスト。デフォルトは、 <tt>'&lt;/li&gt;'</tt> 。
 +
 +
; class : (''文字列'') 各カテゴリーに割り当てられる class 。デフォルトは <tt>'linkcat'</tt> 。 (このパラメーターは [[Version 2.2]] にて追加されました)
 +
 +
; category_orderby : (''文字列'') カテゴリーを並べる値。有効なオプションは:
 +
:* <tt>'name'</tt> - デフォルト
 +
:* <tt>'id'</tt>
 +
:* <tt>'slug'</tt>
 +
:* <tt>'count'</tt>
 +
:* <tt>'term_group'</tt> (まだ使われていない)
 +
 +
; category_order : (''文字列'') 上記、 category_orderby の並べる順を昇順か降順か決めるもの。有効なオプションは:
 +
:* <tt>ASC (昇順)</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>0</tt> (False) - デフォルト
 +
 +
; include : (''文字列'') 出力するブックマークの ID 数字リストをコンマで区切ったもの。例えば、 'include=1,3,6' は、ブックマーク ID の 1, 3, 6 を出力する。もし文字列が使われた場合、 ''category'', ''category_name'', ''exclude'' のパラメーターは無視される。デフォルトは <tt><nowiki>''</nowiki></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>'name'</tt> - デフォルト
 +
:* <tt>'target'</tt>
 +
:* <tt>'description'</tt>
 +
:* <tt>'owner'</tt> - ブックマークマネージャーを通してそれを追加したユーザー。
 +
:* <tt>'rating'</tt>
 +
:* <tt>'updated'</tt> Note: link_updated フィールドはローカルでの更新をトラックするものではありません。これは Pingomatic へのリモートリクエストを経て、リンク先のアップデートをトラックするものです。
 +
:* <tt>'rel'</tt> - ブックマークの関係 (XFN).
 +
:* <tt>'notes'</tt>
 +
:* <tt>'rss'</tt>
 +
:* <tt>'length'</tt> - ブックマーク名。短い順。
 +
:* <tt>'rand'</tt> - ブックマークをランダムな順に表示する。
 +
 +
; order : (''文字列'') 上記、 'orderly' パラメーターの値を昇順か降順か決める。有効な値は:
 +
:* <tt>ASC (昇順)</tt>  - デフォルト
 +
:* <tt>DESC (降順)</tt>
 +
 +
; limit : (''integer'') 表示させるブックマークの最大数。デフォルトは <tt>-1</tt> (全て表示)
 +
 +
; before : (''文字列'') 各ブックマークの前につけるテキスト。デフォルトは、 <tt>'&lt;li&gt;'</tt> 。
 +
 +
; after : (''文字列'') 各ブックマークの後につけるテキスト。デフォルトは、 <tt>'&lt;/li&gt;'</tt> 。
 +
 +
;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)
 +
 +
; show_description : (''真偽値'') ブックマークの説明を表示する (<tt>TRUE</tt>) または表示しない (<tt>FALSE</tt>)。 '''show_images''' が <tt>FALSE</tt> または画像が定義されていない時に有効となる。
 +
:* <tt>1</tt> (True)
 +
:* <tt>0</tt> (False) - デフォルト
 +
 +
; show_name : (''真偽値'') リンクのテキストを表示する (<tt>TRUE</tt>) 。 '''show_images''' が <tt>TRUE</tt> である時に有効となる。 (このパラメーターは [[Version 2.7]] にて追加されました。)
 +
:* <tt>1</tt> (True)
 +
:* <tt>0</tt> (False) - デフォルト
 +
 +
; show_rating : (''真偽値'') 評価の星または文字を表示する (<tt>TRUE</tt>) または表示しない (<tt>FALSE</tt>)。
 +
:* <tt>1</tt> (True)
 +
:* <tt>0</tt> (False) - デフォルト
 +
 +
; 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)
 +
 +
; echo : (''真偽値'') ブックマークを表示させる (<tt>TRUE</tt>) または PHP で使うために返す (<tt>FALSE</tt>) 。
 +
:* <tt>1</tt> (True) - デフォルト
 +
:* <tt>0</tt> (False)
 +
 +
<div id="Examples">
 +
== 使用例 ==
 +
</div>
 
<div id="Simple_List">
 
<div id="Simple_List">
−
=== Simple List ===
+
=== シンプルリスト ===
 
</div>
 
</div>
−
Displays all bookmarks with the title "Bookmarks" and with items wrapped in &lt;li&gt; tags. The title is wrapped in h2 tags.
+
全てのブックマークを "Bookmarks" というタイトルで、 &lt;li&gt; タグで囲んだ状態で表示させる。タイトルは &lt;h2&gt; タグで囲まれる。
−
 
+
 
  <?php wp_list_bookmarks('title_li=&category_before=&category_after='); ?>
 
  <?php wp_list_bookmarks('title_li=&category_before=&category_after='); ?>
  
 
<div id="Simple_List_without_the_Heading">
 
<div id="Simple_List_without_the_Heading">
−
=== Simple List without the Heading ===
+
=== 見出しなしのシンプルリスト ===
 
</div>
 
</div>
−
Displays all bookmarks as above, but does not include the default heading.
+
全てのブックマークをデフォルトの見出し抜きで、あとは上記と同様に表示させる。
−
 
+
 
  <?php wp_list_bookmarks('title_li=&categorize=0'); ?>
 
  <?php wp_list_bookmarks('title_li=&categorize=0'); ?>
  
 
<div id="Specific_Category_Sorted_by_URL">
 
<div id="Specific_Category_Sorted_by_URL">
−
=== 特定のカテゴリを URL でソート ===
+
=== URL でソートされた特定のカテゴリー ===
 
</div>
 
</div>
−
<code><nowiki><span></nowiki></code> タグ内にカテゴリID 2 のブックマークを表示、ブックマークの画像を使用、概要は非表示、ブックマーク URL でソート。
+
カテゴリー 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'); ?>
  
−
<pre>
+
<div id="Shows Ratings and Timestamp">
−
<?php wp_list_bookmarks('categorize=0&category=2&before=<span>&after=</span>&show_images=1&show_description=0&orderby=url'); ?>
+
−
</pre>
+
−
 
+
−
<div id="Shows_Ratings_and_Timestamp">
+
 
=== 評価とタイムスタンプを表示 ===
 
=== 評価とタイムスタンプを表示 ===
 
</div>
 
</div>
−
番号付き箇条書きで全てのブックマークを表示、各ブックマークの 2行目に概要を表示、画像は非表示、ブックマークID でソート、評価・最終更新日時を表示。
+
全てのブックマークを番号付きリストで表示させ、説明を別の行に、イメージを用いず、ブックマーク ID 順で並べ、評価と最終更新のタイムスタンプを表示させる。 (最終更新のタイムスタンプはローカルでの更新をトラックするものではありません。 Pingomatic へのリモートリクエストを経て、リンク先のアップデートをトラックするものです)
  
−
<pre>
+
&lt;ol&gt;
−
<ol>
+
<?php wp_list_bookmarks('between=&lt;br /&gt;&show_images=0&orderby=id&show_rating=1&show_updated=1'); ?>
−
<?php wp_list_bookmarks('between=<br />&show_images=0&orderby=id&show_rating=1&show_updated=1'); ?>
+
&lt;/ol&gt;
−
</ol>
+
−
</pre>
+
  
−
<div id="Parameters">
+
<div id="Replaces Heading with Image">
−
== パラメータ ==
+
=== 見出しを画像に置き換え ===
 
</div>
 
</div>
−
<!--
+
テキストの代わりにテーマフォルダからの画像を用いる。
−
<pre>
+
<?php wp_list_bookmarks('categorize=0&title_before=&title_after=&title_li=<img src="'.get_bloginfo("stylesheet_directory").'/images/blogroll.gif" alt="blogroll" />'); ?>
−
Default settings for actual function will be deleted upon publication
+
−
$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
+
−
: （''真偽値''） ブックマークをカテゴリ分けして表示する（<code>TRUE</code>）か否（<code>FALSE</code>）か。初期値は <code>TRUE</code>（カテゴリ毎に分ける）。
+
−
:* <code>1</code> （True - 初期値）
+
−
:* <code>0</code> （False）
+
−
; category
+
−
: （''文字列''） 表示するカテゴリID の数字をカンマ区切りで指定。特に指定しなければ全カテゴリのブックマークを表示。初期値は <code><nowiki>''</nowiki></code>（全カテゴリ）。
+
−
; category_name
+
−
: （''文字列''） 表示するブックマークのカテゴリ名。特に指定しなければ全カテゴリのブックマークを表示。初期値は <code><nowiki>''</nowiki></code>（全カテゴリ）。
+
−
; category_before
+
−
: （''文字列''） Text to put before each category. Defaults to <code>'&lt;li id="[category id]" class="linkcat"&gt;'</code> .
+
−
; category_after
+
−
: （''文字列''） Text to put before each category. Defaults to <code>'&lt;'/li&gt;'</code> .
+
−
; class
+
−
: （''文字列''） The class each cateogory li will have on it. Defaults to <code>'linkcat'</code> .
+
−
; category_orderby
+
−
: （''文字列''） カテゴリをどの項目でソートするか。初期値は <code>'name'</code>。有効値：
+
−
:* <code>'name'</code> （初期値）
+
−
:* <code>'id'</code>
+
−
:* <code>'slug'</code>
+
−
:* <code>'count'</code>
+
−
:* <code>'term_group'</code> （未使用）
+
−
; category_order
+
−
: （''文字列''） カテゴリを並べ替え順を“昇順”か“降順”で指定できる。何で並べ替えるのか？⇒category_orderby で指定できる。有効値：
+
−
:* <code>ASC</code> （初期値）
+
−
:* <code>DESC</code>
+
−
; title_li
+
−
: （''文字列''） ブックマークリストの見出しとする文字列。初期値は「Bookmarks」（またはその翻訳語句）を表示するための <code>'__('Bookmarks')'</code>（「<code><nowiki>__('○○')</nowiki></code>」は[[WordPress の翻訳|翻訳用の書き方]]）。'categorize' パラメータが 0 のときにのみ有効（ 1 のときは見出しにカテゴリ名が使われる）。null（0）値を指定すると、見出しは表示せず、リストを <code><nowiki><ul>, </ul></nowiki></code> タグで括らない。
+
−
; title_before
+
−
: （''文字列''） 'categorize' パラメータが TRUE のとき、各カテゴリ概要の前に置く文字列。初期値は <code><nowiki>'<h2>'</nowiki></code>。
+
−
; title_after
+
−
: （''文字列''） 'categorize' パラメータが TRUE のとき、各カテゴリ概要の後ろに置く文字列。初期値は <code>'</h2>'</code>。
+
−
; show_private
+
−
: （''真偽値''） プライベートなカテゴリであっても表示するか。管理設定を無視してプライベートカテゴリを表示する（<code>TRUE</code>）か、プライベートカテゴリを表示しない（<code>FALSE</code>）か。初期値は <code>FALSE</code>（表示しない）。
+
−
:* <code>1</code> （True）
+
−
:* <code>0</code> （False - 初期値）
+
−
; include
+
−
: （''文字列''） 出力に含めるブックマークID の数字をカンマ区切りで指定。例えば <code>'include=1,3,6'</code> とすれば、ブックマークID が 1, 3, 6 のものを返す／表示する。このパラメータを指定すると、''category'', ''category_name'', ''exclude'' パラメータの指定は無視される。初期値は <code><nowiki>''</nowiki></code>（全ブックマーク）。
+
−
; exclude
+
−
: （''文字列''） 出力から除外するブックマークID の数字をカンマ区切りで指定。例えば <code>'exclude=4,12'</code> とすれば、ブックマークID が 4, 12 のものは返さない／表示しない。初期値は <code><nowiki>''</nowiki></code>（除外なし）。
+
−
; orderby
+
−
: （''文字列''） ブックマークをどの項目でソートするか。<code>'id'</code> とするために <code><nowiki>''</nowiki></code>（ブランク）を指定するのでない限り、初期値は <code>'name'</code>。有効値：
+
−
:* <code>'id'</code>
+
−
:* <code>'url'</code>
+
−
:* <code>'name'</code>
+
−
:* <code>'target'</code>
+
−
:* <code>'description'</code>
+
−
:* <code>'owner'</code> - ブックマーク管理パネルでブックマークを追加したユーザ
+
−
:* <code>'rating'</code>
+
−
:* <code>'updated'</code>
+
−
:* <code>'rel'</code> - ブックマーク先との続柄（bookmark relationship）(XFN).
+
−
:* <code>'notes'</code>
+
−
:* <code>'rss'</code>
+
−
:* <code>'length'</code> - The length of the bookmark name, shortest to longest.
+
−
:* <code>'rand'</code> - ランダムな順序でブックマークを表示
+
−
; order
+
−
: ブックマークのソート順。orderby パラメータで指定した項目の昇順か降順か。有効値：
+
−
:* <code>ASC</code> （初期値）
+
−
:* <code>DESC</code>
+
−
; limit
+
−
: （''整数''） 表示するブックマークの最大数。初期値は <code>-1</code>（全ブックマーク）。
+
−
; before
+
−
: （''文字列''） 各ブックマークの前に置く文字列。初期値は <code><nowiki>'<li>'</nowiki></code>。
+
−
; after
+
−
: （''文字列''） 各ブックマークの後ろに置く文字列。初期値は <code><nowiki>'</li>'</nowiki></code>。
+
−
; category_before
+
−
: （''文字列''） 各カテゴリの前に置く文字列。初期値は、それぞれに見合った <code>id</code> と <code>class</code> 属性付きの <code><nowiki>'<li>'</nowiki></code> 。
+
−
; category_after
+
−
: （''文字列''） 各カテゴリの後ろに置く文字列。初期値は <code><nowiki>'</li>'</nowiki></code>。
+
−
; between
+
−
: （''文字列''） 各ブックマーク／画像とその概要との間に置く文字列。初期値は <code>'\n'</code>（HTMLコード上の改行？）。<!-- \n なら HTMLコード上の改行、サイト表示上の改行（br）ではない、たぶん。 -->
+
−
; show_images
+
−
: （''真偽値''） ブックマーク画像を表示する（<code>TRUE</code>）か否（<code>FALSE</code>）か。初期値は <code>TRUE</code>（表示）。
+
−
:* <code>1</code> （True - 初期値）
+
−
:* <code>0</code> （False）
+
−
; show_description
+
−
: （''真偽値''） 各ブックマークの概要を表示する（）か否（）か。'''show_images''' パラメータが <code>FALSE</code> のときか、画像が定義されていないときに有効。初期値は <code>FALSE</code>（表示しない）。
+
−
:* <code>1</code> （True）
+
−
:* <code>0</code> （False - 初期値）
+
−
; show_rating
+
−
: （''真偽値''） 各ブックマークの評価の星／文字を表示する（<code>TRUE</code>）か否（<code>FALSE</code>）か。初期値は <code>FALSE</code>（表示しない）。
+
−
:* <code>1</code> （True）
+
−
:* <code>0</code> （False - 初期値）
+
−
; show_updated
+
−
: （''真偽値''） 各ブックマークの最終更新日時を表示する（<code>TRUE</code>）か否（<code>FALSE</code>）か。初期値は <code>FALSE</code>（表示しない）。
+
−
:* <code>1</code> （True）
+
−
:* <code>0</code> （False - 初期値）
+
−
; hide_invisible
+
−
: （''真偽値''） Visible 設定が No のブックマークを非表示とするか。管理パネルでの設定に従う（<code>TRUE</code>）か、無視する（<code>FALSE</code>）か。初期値は <code>TRUE</code>（管理設定どおり。No なら非表示）。
+
−
:* <code>1</code> （True - 初期値）
+
−
:* <code>0</code> （False）
+
−
; echo
+
−
: （''真偽値''） ブックマークを表示する（<code>TRUE</code>）か、PHP で使うために値として返す（<code>FALSE</code>）か。初期値は <code>TRUE</code>（表示）。
+
−
:* <code>1</code> （True - 初期値）
+
−
:* <code>0</code> （False）
+
  
−
== 変更履歴 ==
+
<div id="Change Log">
−
* [[Version 2.7|2.7]] : パラメータに <code>exclude_category</code>、<code>link_before</code>、<code>link_after</code>、<code>show_name</code> が追加されました。
+
== 改訂履歴 ==
−
* [[Version 2.1|2.1]] : 新規テンプレートタグ
+
</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="Related">
+
<div id="Source File">
−
== 関連 ==
+
== ソースファイル ==
 
</div>
 
</div>
 +
<tt>wp_list_bookmarks()</tt> は {{Trac|wp-includes/bookmark-template.php}} にあります。
  
−
{{Bookmark_Tags}}
+
<div id="Related">
−
 
+
== 関連項目 ==
−
{{PHP Function Tag Footer}}
+
</div>
 +
{{Bookmark Tags}}
  
−
{{原文|Template Tags/wp_list_bookmarks|58256}}<!-- 15:39, June 12, 2008 Otto42 版 -->
+
{{Lists Tags}}
  
−
{{DEFAULTSORT:Wp_list_bookmarks}}
+
{{Tag Footer}}
−
[[Category:wp2.1]]
+
−
[[Category:wp2.7]]
+
  
−
[[en:Template Tags/wp_list_bookmarks]]
+
{{原文|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" />'); ?>

改訂履歴

ソースファイル

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

「http://wpdocs.osdn.jp/wiki/index.php?title=テンプレートタグ/wp_list_bookmarks&oldid=9321」から取得