wp_list_bookmarks()


WordPressのwp_list_bookmarks()関数は、ブックマーク（リンク）を表示するために使用されます。この関数は、リンクマネージャーに登録されたリンクをリスト形式で出力します。

構文

wp_list_bookmarks( array|string $args = '' );

引数の説明:

  • $args(array|string) — リンクの表示方法を制御するための引数。配列またはクエリ文字列形式で指定できます。
  • categorize(bool) — リンクをカテゴリーごとにグループ化するかどうか。デフォルトはtrue。
  • category(int|string) — 表示するリンクのカテゴリーIDまたは名前。デフォルトは空。
  • category_name(string) — 表示するリンクのカテゴリー名。デフォルトは空。
  • class(string) — リンクリストに適用するCSSクラス。デフォルトは’linkcat’。
  • category_before(string) — カテゴリーの前に表示するHTML。デフォルトは'<li id=”%id” class=”%class”>’。
  • category_after(string) — カテゴリーの後に表示するHTML。デフォルトは'</li>’。
  • title_before(string) — リンクタイトルの前に表示するHTML。デフォルトは'<h2>’。
  • title_after(string) — リンクタイトルの後に表示するHTML。デフォルトは'</h2>’。

例1: 基本的なリンクリストの表示

この例では、登録されたすべてのリンクをカテゴリーごとに表示します。

<?php wp_list_bookmarks(); ?>

例2: 特定のカテゴリーのリンクを表示

この例では、カテゴリーIDが2のリンクのみを表示します。

<?php wp_list_bookmarks('category=2'); ?>

例3: カテゴリーごとにグループ化しない

この例では、リンクをカテゴリーごとにグループ化せずに表示します。

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

例4: カスタムCSSクラスの適用

この例では、リンクリストにカスタムCSSクラスを適用します。

<?php wp_list_bookmarks('class=my-custom-class'); ?>

例5: カテゴリー名を非表示にする

この例では、カテゴリー名を表示せずにリンクのみを表示します。

<?php wp_list_bookmarks('title_li='); ?>

例6: カスタムHTMLでカテゴリーを囲む

この例では、カテゴリーをカスタムHTMLで囲みます。

<?php wp_list_bookmarks('category_before=&lt;div class="my-category"&gt;', 'category_after=&lt;/div&gt;'); ?>

例7: リンクタイトルをカスタマイズ

この例では、リンクタイトルをカスタマイズして表示します。

<?php wp_list_bookmarks('title_before=&lt;h3 class="link-title"&gt;', 'title_after=&lt;/h3&gt;'); ?>

例8: リンクの順序を変更

この例では、リンクを名前順に並べ替えて表示します。

<?php wp_list_bookmarks('orderby=name'); ?>

注意点

  • リンクマネージャーが有効になっていることを確認してください。
  • カテゴリーIDや名前を指定する際は、正しい値を使用してください。
  • カスタムHTMLを使用する際は、閉じタグを忘れないように注意してください。

関連機能：