ワードプレスのget_bookmarks関数の使用方法・解説

概要

get_bookmarks 関数は、WordPressで保存されたリンク情報を取得するために使用されます。この関数は、主に以下のような機能を実装する際に使用されます：

1. Webサイトのブックマークを表示する。
2. RSSフィードや外部リンクを集約する。
3. 関連リンクをサイドバーに表示する。
4. リンク集ページを作成する。
5. カスタム投稿タイプとしてのリンクを管理する。
6. サイト内の関連リソースをリンク形式で一覧表示する。
7. 特定のカテゴリやタグに基づくリンクを取得する。
8. リアルタイムでリンク情報を更新する。

構文

get_bookmarks($args);

パラメータ

• $args (配列) – 取得するブックマークのオプション。デフォルトは array()。

戻り値

• array – リンクオブジェクトの配列。リンクが存在しない場合は空の配列を返す。

関連する関数

• get_bookmark()
• wp_list_bookmarks()

使用可能なバージョン

• この関数は、WordPress 2.2.0 から使用可能です。

コアファイルのパス

• wp-includes/link.php

この関数のアクションでの使用可能性

アクション	使用可能性
mu_plugin_loaded
registered_post_type
plugins_loaded	〇
wp_roles_init
setup_theme
after_setup_theme
set_current_user
init
register_sidebar
wp_loaded	〇
send_headers
parse_query
pre_get_posts
wp
template_redirect
get_header
wp_head

非推奨または削除されたバージョン

• 特に非推奨または削除されているバージョンはありません。

サンプルコード

サンプルコード1: 基本的なブックマークの取得

$bookmarks = get_bookmarks();
foreach ($bookmarks as $bookmark) {
    echo '<a href="' . esc_url($bookmark->link_url) . '">' . esc_html($bookmark->link_name) . '</a><br>';
}

このコードは、保存された全てのブックマークを取得し、リンク名とURLを表示します。

サンプルコード2: 特定のカテゴリのブックマークを取得

$args = array('category' => 'my-category');
$bookmarks = get_bookmarks($args);
foreach ($bookmarks as $bookmark) {
    echo '<a href="' . esc_url($bookmark->link_url) . '">' . esc_html($bookmark->link_name) . '</a><br>';
}

このコードは、指定したカテゴリのリンク情報を取得し、リスト表示します。

サンプルコード3: 限定された数のブックマークを取得

$args = array('number' => 5);
$bookmarks = get_bookmarks($args);
foreach ($bookmarks as $bookmark) {
    echo '<a href="' . esc_url($bookmark->link_url) . '">' . esc_html($bookmark->link_name) . '</a><br>';
}

このコードでは、最新の5つのブックマークを取得して表示します。

サンプルコード4: 特定のオプションを指定して取得

$args = array('orderby' => 'name', 'order' => 'ASC');
$bookmarks = get_bookmarks($args);
foreach ($bookmarks as $bookmark) {
    echo '<a href="' . esc_url($bookmark->link_url) . '">' . esc_html($bookmark->link_name) . '</a><br>';
}

このコードは、ブックマークを名前の順に取得し、表示します。

サンプルコード5: リンクのカスタム出力

$bookmarks = get_bookmarks();
foreach ($bookmarks as $bookmark) {
    echo '<div class="bookmark">';
    echo '<h3>' . esc_html($bookmark->link_name) . '</h3>';
    echo '<p>' . esc_html($bookmark->link_description) . '</p>';
    echo '<a href="' . esc_url($bookmark->link_url) . '">Visit</a>';
    echo '</div>';
}

このコードは、ブックマークをカスタムHTML形式で表示します。名前、説明、リンクを含む構造です。