MENU
  1. Home
  2. WordPress リファレンス
  3. Function
  4. get_bookmark()

get_bookmark()

広告
Function

get_bookmark() は、WordPressで登録されたブックマーク（リンク）に関する詳細情報を取得するテンプレートタグです。取得されたブックマークのデータはオブジェクトとして返され、様々な形で利用することができます。

目次

機能の説明

get_bookmark() は、指定されたリンク（ブックマーク）の詳細な情報を取得し、それをオブジェクトとして返します。リンクのIDを指定することで、そのリンクに関連する情報を柔軟に取得し、カスタマイズして表示することが可能です。

シンプルなコード例

<?php
$bookmark = get_bookmark(10);
echo $bookmark->link_name;
?>

この例では、IDが 10 のブックマークを取得し、その名前を表示しています。

使い方の解説

get_bookmark() を使用することで、リンクIDに基づいて、特定のリンクの情報を取得できます。リンクに関連する様々なフィールド（リンク名、URL、説明、画像など）を取得し、それらをカスタマイズして表示する際に便利です。

使用例

<?php
$bookmark = get_bookmark(15);
echo '<h2>' . $bookmark->link_name . '</h2>';
echo '<a href="' . $bookmark->link_url . '">' . $bookmark->link_name . '</a>';
echo '<p>' . $bookmark->link_description . '</p>';
?>

このコードでは、リンクIDが 15 のブックマークを取得し、以下の内容を表示しています：

  • リンクの名前を見出しとして表示 ($bookmark->link_name)
  • リンクのURLをクリック可能なアンカータグとして出力 ($bookmark->link_url)
  • リンクの説明をパラグラフで表示 ($bookmark->link_description)

get_bookmark() を利用することで、リンクの情報を柔軟に取得し、自由にレイアウトをカスタマイズできます。

一緒に使うことが多い関連タグ

wp_list_bookmarks()

wp_list_bookmarks() は、WordPressに登録された複数のリンクをリスト形式で表示するテンプレートタグです。get_bookmark() が単一のリンクを取得するのに対して、wp_list_bookmarks() は複数のリンクを一覧表示する場合に使用されます。

使用例

<?php wp_list_bookmarks(array(
    'category_name' => 'External Links',
    'orderby' => 'name',
    'order' => 'ASC'
)); ?>

このコードは、指定されたカテゴリ「External Links」に属するリンクを名前順でリスト表示しています。wp_list_bookmarks() は複数のリンクを簡単に表示できるため、get_bookmark() と組み合わせて、特定のリンクを強調するレイアウトが可能です。

get_bookmarks()

get_bookmarks() は、指定された条件に基づいて複数のブックマークを取得するテンプレートタグです。get_bookmark() と異なり、リンクの配列を返すため、ループ処理で複数のリンクをカスタマイズして表示する際に使用します。

使用例

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

このコードは、カテゴリID 2 に属するリンクを取得し、それらを名前順で並べ替えて表示しています。get_bookmarks() では、複数のリンクを取得できるため、ループ処理によってカスタム表示を行うことができます。

追加情報を取得したい場合

get_bookmark() で取得できるのは特定のブックマークに関する情報ですが、さらなる詳細やリンクの分類に関する情報を追加で取得したい場合は、他のテンプレートタグを使用します。

get_category()で取得できる情報

get_category() を使用して、リンクが属するカテゴリ情報を取得できます。

<?php
$category = get_category(3);
echo 'カテゴリ名: ' . $category->name;
echo 'カテゴリスラッグ: ' . $category->slug;
?>

このコードは、カテゴリID 3 のカテゴリ情報を取得し、その名前とスラッグを表示しています。リンクが属するカテゴリ情報を追加することで、さらに豊富なコンテンツが作成できます。

出力できる情報

  • name: カテゴリー名
  • slug: カテゴリーのスラッグ（URL フレンドリーな名前）
  • description: カテゴリーの説明
  • count: そのカテゴリーに属する投稿数

使用する事で想定されるトラブル

リンクが取得できない

リンクIDが存在しない、または間違っている可能性があります。

解決方法

管理画面でリンクが登録されていること、またはリンクIDが正しいことを確認してください。

カスタムフィールドが表示されない

get_bookmark() で取得したリンクデータに必要なカスタムフィールドが含まれていない場合があります。

解決方法

カスタムフィールドの追加が必要な場合は、リンクの管理画面から適切な情報を追加してください。

Q&A

get_bookmark() でリンクの画像も取得できますか？

はい、リンクに画像が設定されている場合、link_image フィールドで画像URLを取得できます。

$bookmark = get_bookmark(10);
echo '<img src="' . $bookmark->link_image . '" alt="' . $bookmark->link_name . '">';

特定のリンクカテゴリからリンクを取得できますか？

直接的にはできませんが、get_bookmarks() を使うことで特定のカテゴリからリンクを取得できます。

$bookmarks = get_bookmarks(array('category' => 2));

get_bookmark() の戻り値はどんなデータ形式ですか？

get_bookmark() の戻り値はオブジェクト形式で、リンクに関する様々なフィールド（link_name, link_url, link_description など）を含んでいます。

まとめ

get_bookmark() は、WordPressに登録された特定のリンク情報を取得するためのテンプレートタグです。

リンクIDに基づいて詳細情報をオブジェクト形式で返し、リンク名やURL、説明、画像などを柔軟に表示することができます。wp_list_bookmarks() や get_bookmarks() などの関連タグと組み合わせることで、リンクの表示方法をさらにカスタマイズできます。

Function
よかったらシェアしてね！
  • URLをコピーしました！

コメント

コメントする

This site uses Akismet to reduce spam. Learn how your comment data is processed.

目次