wp_list_bookmarks()

wp_list_bookmarks()
目次

wp_list_bookmarks()の用途

wp_list_bookmarks() は、WordPressに登録されたブックマーク(リンク)を一覧表示するためのテンプレートタグです。WordPress 2.x 系まであった「リンクマネージャー」機能(blogroll)に関連する関数で、現在はデフォルトでは非表示機能となっています。

wp_list_bookmarks()の基本構文

wp_list_bookmarks( $args );
  • $args は配列またはクエリ形式の文字列で渡します(例:'category=3&orderby=name')。

wp_list_bookmarks()の主な用途

  • リンク集(Blogroll)やお気に入りサイト一覧をテンプレートに表示
  • 「リンクマネージャー」プラグインを有効化した環境で活用
  • 古いテーマやカスタマイズされたサイトで使われることがある

wp_list_bookmarks()の注意点(重要)

WordPress 3.5以降、新規インストールでは「リンク」メニューが非表示になっており、wp_list_bookmarks() を使うには別途対応が必要です。

表示させるには

  • プラグイン「Link Manager」を有効化する
  • または functions.php に以下のコードを追加:
add_filter( 'pre_option_link_manager_enabled', '__return_true' );

wp_list_bookmarks()のよく使う引数一覧($args

引数説明
categoryカテゴリIDまたはスラッグ(例:3, 'blogroll')を指定
orderby並び順(例:'name', 'rating', 'id', 'rand'
order昇順・降順('ASC' / 'DESC'
limit表示件数
show_description説明文を表示するか(true / false
show_ratingレーティング(評価)を表示
show_updated最終更新日を表示するか
title_before / title_afterカテゴリタイトルの前後のHTML
category_before / category_afterカテゴリ全体のラップタグ(例:<ul>など)
categorizeカテゴリ別に分類表示するか(true)か一覧でまとめるか(false
echotrue(表示)/ false(返り値)

wp_list_bookmarks()の使用例

基本的なブックマークリストを表示

<?php wp_list_bookmarks(); ?>

「Blogroll」カテゴリのリンクを名前順に表示

<?php
wp_list_bookmarks( array(
  'category_name' => 'blogroll',
  'orderby' => 'name',
  'order' => 'ASC',
  'show_description' => true
) );
?>

カテゴリ分けせずに一括で表示(categorize => false

<?php
wp_list_bookmarks( array(
  'categorize' => false,
  'title_li' => '',
  'show_description' => false
) );
?>

wp_list_bookmarks()の出力されるHTML例

<li><a href="https://example.com" title="説明文">サイト名</a></li>

また、categorize => true の場合:

<h2>カテゴリ名</h2>
<ul>
  <li><a href="...">リンクA</a></li>
  <li><a href="...">リンクB</a></li>
</ul>

echo => false で文字列取得

$bookmark_list = wp_list_bookmarks( array(
  'echo' => false,
  'limit' => 5
) );
echo '<div class="bookmark-box">' . $bookmark_list . '</div>';

wp_list_bookmarks()のまとめ

項目内容
関数名wp_list_bookmarks()
目的WordPressに登録したブックマーク(リンク)をリスト表示
対象機能古い「リンクマネージャー(blogroll)」機能
注意点WordPress 3.5以降は初期状態で無効。再有効化が必要
主な引数category, orderby, show_description, categorize など

wp_list_bookmarks()の関連関数・補足

  • get_bookmarks():ブックマークデータを取得する(出力しない)
  • wp_get_links():古い関数。非推奨(Deprecated)
  • カスタムメニューやカスタム投稿タイプが主流になった今では、あえてこの関数を使うケースは少なくなってきています
よかったらシェアしてね!
  • URLをコピーしました!
  • URLをコピーしました!

この記事を書いた人

初めてホームページを作成したのは1996年。
2000年よりフリーランスで主に中小企業、学校、各種公的団体、個人事業主のWordPressを活用したホームページ制作を行っています。WordPressテーマはそれぞれのクライアントに合わせて作成しています。
WordPressを活用したサイト運営のための情報発信をしていきます。

目次