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

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

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(Djkazトーク)による第6297版を取り消し)
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>
この関数は[[管理画面]] > [[管理パネル/リンク|リンク]] パネルにあるブックマークを表示するものです。この[[Template Tags|テンプレートタグ]]はブックマークの配列と表示をコントロールさせるものです。
+
この関数は [[Version 2.1|WordPress バージョン 2.1]] 以上で使えます。2.0.x 系には対応していません。
 
+
[[テンプレートタグ/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 ); ?>
 
  
<div id="Default_Usage">
+
<?php wp_list_bookmarks('引数'); ?>
=== 初期設定での使い方 ===
+
 
 +
<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>
 
  
By default, the function shows:
+
<div id="Default_Usage">
* Bookmarks divided into Categories with a Category name heading
+
=== 初期設定での使用 ===
* All bookmarks included, regardless of Category Name or Category ID
+
* Sorts the list by name
+
* An image if one is included
+
* A space between the image and the text
+
* Shows the description of the bookmark
+
* Does not show the ratings
+
* Unless limit is set, shows all bookmarks
+
* Displays bookmarks
+
 
+
<div id="Parameters">
+
== パラメータ ==
+
 
</div>
 
</div>
; categorize : (''boolean'') Bookmarks should be shown within their assigned Categories or not.
+
<pre>
:* <tt>1</tt> (True) - Default
+
$defaults = array(
:* <tt>0</tt> (False)
+
'orderby' => 'name',
 +
'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 : (''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).
+
デフォルトでは次のように表示されます。
 +
* ブックマークをカテゴリ毎に分け、カテゴリ名の見出しを付ける
 +
* 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)は非表示
 +
* 表示数制限なし、全てのブックマークを表示
 +
* ブックマークを表示(サイトに表示するか値を返すかを選べるので)
  
; exclude_category : (''string'') Comma separated list of numeric Category IDs to be excluded from display. Defaults to <tt>''</tt> (no categories excluded).
+
<?php wp_list_bookmarks(); ?>
  
; 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_before : (''string'') Text to place before each category. Defaults to <tt>'&lt;li id="[category id]" class="linkcat"&gt;'</tt> .
 
 
; category_after : (''string'') Text to place after each category. Defaults to <tt>'&lt;/li&gt;'</tt> .
 
 
; class : (''string'') The class each category li will have on it. Defaults to <tt>'linkcat'</tt> . (This parameter was added with [[Version 2.2]])
 
 
; category_orderby : (''string'') Value to sort Categories on. Valid options:
 
:* <tt>'name'</tt> - Default
 
:* <tt>'id'</tt>
 
:* <tt>'slug'</tt>
 
:* <tt>'count'</tt>
 
:* <tt>'term_group'</tt> (not used yet)
 
 
; category_order : (''string'') Sort order, ascending or descending for the category_orderby parameter. Valid values:
 
:* <tt>ASC</tt> - Default
 
:* <tt>DESC</tt>
 
 
; title_li : (''string'') Text for the heading of the links list. Defaults to <tt>'__('Bookmarks')'</tt>, which displays "Bookmarks" (the <tt>__(&#039;&#039;)</tt> is used for [[Localization|localization purposes]]).  Only used when categorize are set to 0 [false] (else the category names will be used instead). If 'title_li' is set to null (0) value, no heading is displayed, and the list will not be wrapped with <tt>&lt;ul>, &lt;/ul></tt> tags (be sure to pass the categorize option to 0 [false] to this option takes effect).
 
 
; title_before : (''string'') Text to place before each Category description if 'categorize' is 1 [true], or text defined in "title_li" if 'categorize' is 0 [false].  Defaults to <tt>'&lt;h2&gt;'</tt>.
 
 
; title_after : (''string'') Text to place after each Category description if 'categorize' is 1 [true], or text defined in "title_li" if 'categorize' is 0 [false].  Defaults to <tt>'&lt;/h2&gt;'</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>).
 
:* <tt>1</tt> (True)
 
:* <tt>0</tt> (False) - Default
 
 
; 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).
 
 
; orderby : (''string'') Value to sort bookmarks on. This can be a COMMA separated list of values. 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' (use 'link_id' with WP 3.2 and later)</tt>
 
:* <tt>'url'</tt>
 
:* <tt>'name'</tt> - Default
 
:* <tt>'target'</tt>
 
:* <tt>'description'</tt>
 
:* <tt>'owner'</tt> - User who added bookmark through bookmarks Manager.
 
:* <tt>'rating'</tt>
 
:* <tt>'updated'</tt> Note: the link_updated field does not track local modifications. It tracks when whatever the link points to is updated via remote requests to pingomatic.
 
:* <tt>'rel'</tt> - bookmark relationship (XFN).
 
:* <tt>'notes'</tt>
 
:* <tt>'rss'</tt>
 
:* <tt>'length'</tt> - The length of the bookmark name, shortest to longest. 
 
:* <tt>'rand'</tt> - Display bookmarks in random order. 
 
 
; order : (''string'') Bookmarks display sorting order, ascending or descending as defined in the 'orderby' parameter. Valid values:
 
:* <tt>ASC</tt> - Default
 
:* <tt>DESC</tt>
 
 
; limit : (''integer'') Maximum number of bookmarks to display. Default is <tt>-1</tt> (all bookmarks).
 
 
; before : (''string'') Text to place before each bookmark. Defaults to <tt>'&lt;li&gt;'</tt>.
 
 
; after : (''string'') Text to place after each bookmark. Defaults to <tt>'&lt;/li&gt;'</tt>.
 
 
;link_before : (''string'') Text to place before the text of each bookmark, inside the hyperlink code. There is no set default. (This parameter was added with [[Version 2.7]])
 
 
;link_after : (''string'') Text to place after the text of each bookmark. There is no set default. (This parameter was added with [[Version 2.7]])
 
 
; between : (''string'') Text to place between each bookmark/image and its description. Defaults to <tt>'\n'</tt> (newline).
 
 
; show_images : (''boolean'') Should images for bookmarks be shown (<tt>TRUE</tt>) or not (<tt>FALSE</tt>).
 
:* <tt>1</tt> (True) - Default
 
:* <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.
 
:* <tt>1</tt> (True)
 
:* <tt>0</tt> (False) - Default
 
 
; show_name : (''boolean'') Displays the text of a link when (<tt>TRUE</tt>). Works when '''show_images''' is <tt>TRUE</tt>. (This parameter was added with [[Version 2.7]])
 
:* <tt>1</tt> (True)
 
:* <tt>0</tt> (False) - Default
 
 
; show_rating : (''boolean'') Should rating stars/characters be displayed (<tt>TRUE</tt>) or not (<tt>FALSE</tt>).
 
:* <tt>1</tt> (True)
 
:* <tt>0</tt> (False) - Default
 
 
; show_updated : (''boolean'') Should the last updated timestamp be displayed (<tt>TRUE</tt>) or not (<tt>FALSE</tt>). Note that link_updated does not track local modifications. It tracks when whatever the link points to is updated via remote requests to pingomatic.
 
:* <tt>1</tt> (True)
 
:* <tt>0</tt> (False) - Default
 
 
; 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>).
 
:* <tt>1</tt> (True) - Default
 
:* <tt>0</tt> (False)
 
 
; echo : (''boolean'') Display bookmarks (<tt>TRUE</tt>) or return them for use by PHP (<tt>FALSE</tt>).
 
:* <tt>1</tt> (True) - Default
 
:* <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.
 
Displays all bookmarks with the title "Bookmarks" and with items wrapped in &lt;li&gt; tags. The title is wrapped in h2 tags.
159行目: 64行目:
  
 
<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.
 
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'); ?>
 
=== Specific Category Sorted by URL ===
 
  
 
<div id="Specific_Category_Sorted_by_URL">
 
<div id="Specific_Category_Sorted_by_URL">
=== URL でソートされた特定のカテゴリー ===
+
=== 特定のカテゴリを URL でソート ===
 
</div>
 
</div>
Displays bookmarks for Category ID 2 in span tags, uses images for bookmarks, does not show descriptions, sorts by bookmark URL.
+
<code><nowiki><span></nowiki></code> タグ内にカテゴリID 2 のブックマークを表示、ブックマークの画像を使用、概要は非表示、ブックマーク 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>
 +
<?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 id="Shows_Ratings_and_Timestamp">
 
=== 評価とタイムスタンプを表示 ===
 
=== 評価とタイムスタンプを表示 ===
 
</div>
 
</div>
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 (Note that the last updated timestamp does not track local modifications. It tracks when whatever the link points to is updated via remote requests to pingomatic.)
+
番号付き箇条書きで全てのブックマークを表示、各ブックマークの 2行目に概要を表示、画像は非表示、ブックマークID でソート、評価・最終更新日時を表示。
  
&lt;ol&gt;
+
<pre>
<?php wp_list_bookmarks('between=&lt;br /&gt;&show_images=0&orderby=id&show_rating=1&show_updated=1'); ?>
+
<ol>
&lt;/ol&gt;
+
<?php wp_list_bookmarks('between=<br />&show_images=0&orderby=id&show_rating=1&show_updated=1'); ?>
 +
</ol>
 +
</pre>
  
<div id="Replaces Heading with Image">
+
<div id="Parameters">
=== ヘディングを画像に置き換え ===
+
== パラメータ ==
 
</div>
 
</div>
Uses an image from the theme folder instead of plain text.
+
<!--
 +
<pre>
 +
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)
  
<?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|2.7]] : パラメータに <code>exclude_category</code><code>link_before</code><code>link_after</code><code>show_name</code> が追加されました。
<div id="Change Log">
+
* [[Version 2.1|2.1]] : 新規テンプレートタグ
== 改訂履歴 ==
+
</div>
+
* [[Version 2.7|2.7.0]] : Added the <code>link_before</code>, <code>link_after</code> and <code>show_name</code> parameters.
+
* [[Version 2.2|2.2.0]] : Added the <code>class</code> parameter.
+
* Since: [[Version 2.1|2.1.0]]
+
 
+
<div id="Source File">
+
== ソースファイル ==
+
</div>
+
<tt>wp_list_bookmarks()</tt> は {{Trac|wp-includes/bookmark-template.php}} にあります。
+
  
 
<div id="Related">
 
<div id="Related">
== 関連項目 ==
+
== 関連 ==
 
</div>
 
</div>
  
{{原文|Function Reference/wp list bookmarks|141103}}<!-- 22:01, February 8, 2014 Djkaz 版 -->
+
{{Bookmark_Tags}}
 
+
  
{{Bookmark Tags}}
+
{{PHP Function Tag Footer}}
  
{{Lists Tags}}
+
{{原文|Template Tags/wp_list_bookmarks|58256}}<!-- 15:39, June 12, 2008 Otto42 版 -->
  
{{Tag Footer}}
+
{{DEFAULTSORT:Wp_list_bookmarks}}
 +
[[Category:wp2.1]]
 +
[[Category:wp2.7]]
  
[[Category:Template Tags]]
+
[[en:Template Tags/wp_list_bookmarks]]

2014年2月8日 (土) 22:31時点における版

このページ「テンプレートタグ/wp list bookmarks」は 情報が古くなっている可能性があります。最新版英語)も合わせてご覧ください。最新に更新してくださる協力者を求めています

  • バージョン 2.7 でパラメータ 'exclude_category', 'link_before', 'link_after', 'show_name' が追加されています。

このページ「テンプレートタグ/wp list bookmarks」は一部未翻訳です。和訳や日本語情報を加筆してくださる協力者を求めています

この関数は WordPress バージョン 2.1 以上で使えます。2.0.x 系には対応していません。 wp_list_bookmarks() は、管理パネル > 管理 > リンク/en パネルにあるブックマークを表示します。ブックマークの表示順や表示内容を指定できます。このタグは、テンプレートタグ '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,
'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>'
);

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

  • ブックマークをカテゴリ毎に分け、カテゴリ名の見出しを付ける
  • 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(); ?>

Simple List

Displays all bookmarks with the title "Bookmarks" and with items wrapped in <li> tags. The title is wrapped in h2 tags.

<?php wp_list_bookmarks('title_li=&category_before=&category_after='); ?>

Simple List without the Heading

Displays all bookmarks as above, but does not include the default heading.

<?php wp_list_bookmarks('title_li=&categorize=0'); ?>

特定のカテゴリを 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_before
文字列) Text to put before each category. Defaults to '<li id="[category id]" class="linkcat">' .
category_after
文字列) Text to put before each category. Defaults to '<'/li>' .
class
文字列) The class each cateogory li will have on it. Defaults to 'linkcat' .
category_orderby
文字列) カテゴリをどの項目でソートするか。初期値は 'name'。有効値:
  • 'name' (初期値)
  • 'id'
  • 'slug'
  • 'count'
  • 'term_group' (未使用)
category_order
文字列) カテゴリを並べ替え順を“昇順”か“降順”で指定できる。何で並べ替えるのか?⇒category_orderby で指定できる。有効値:
  • ASC (初期値)
  • DESC
title_li
文字列) ブックマークリストの見出しとする文字列。初期値は「Bookmarks」(またはその翻訳語句)を表示するための '__('Bookmarks')'(「__('○○')」は翻訳用の書き方)。'categorize' パラメータが 0 のときにのみ有効( 1 のときは見出しにカテゴリ名が使われる)。null(0)値を指定すると、見出しは表示せず、リストを <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)

変更履歴

  • 2.7 : パラメータに exclude_categorylink_beforelink_aftershow_name が追加されました。
  • 2.1 : 新規テンプレートタグ


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


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


最新英語版: WordPress Codex » Template Tags/wp_list_bookmarks最新版との差分