概要
get_bookmark 関数は、WordPress のデータベースからブックマークの情報を取得するための関数です。この関数は、特に以下のような機能を実装する際によく使われます。
- ブックマークリンクのリストを表示する
- おすすめサイトの紹介ページを作成する
- 企業の関連リンク集を作成する
- ユーザーが追加したリンクを表示する
- カスタム投稿タイプとしてリンクを管理する
- テーマによるブックマークのカスタマイズ
- ブックマークを管理するためのショートコード作成
- SEO対策の一環として外部リンクを集約する
構文
get_bookmark( $bookmark_id, $output, $filter );
パラメータ
$bookmark_id(int) : 取得するブックマークの ID。$output(string) : 出力形式。デフォルトは ‘OBJECT’ (オブジェクト)、’ARRAY_A’ (連想配列)、’ARRAY_N’ (数値配列) が使用可能です。$filter(bool) : フィルターを適用するかどうか。デフォルトは true。
戻り値
指定されたブックマークの情報を含むオブジェクトまたは配列。
関連する関数
使用可能なバージョン
get_bookmark 関数は WordPress 2.0.0 以降で使用できます。
コアファイルのパス
wp-includes/bookmark.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: 基本的な使用法
$bookmark = get_bookmark( 1 );
echo $bookmark->link_name;
このコードは、IDが1のブックマークの名前を取得して表示します。
サンプルコード 2: リンクをリスト表示
$bookmarks = get_bookmarks();
foreach ( $bookmarks as $bookmark ) {
echo '<a href="' . esc_url( $bookmark->link_url ) . '">' . esc_html( $bookmark->link_name ) . '</a><br>';
}
このコードは、すべてのブックマークのリンクをリスト表示します。
サンプルコード 3: フィルタ付きで取得
$bookmark = get_bookmark( 1, 'ARRAY_A', false );
echo $bookmark['link_name'];
このコードは、IDが1のブックマークを連想配列として取得し、名前を表示します。
サンプルコード 4: 特定の条件で取得
$args = array(
'orderby' => 'name',
'order' => 'ASC'
);
$bookmarks = get_bookmarks( $args );
このコードは、ブックマークを名前の昇順で取得します。
サンプルコード 5: ブックマークのカスタマイズ
$bookmark = get_bookmark( 1, 'OBJECT' );
$bookmark->link_description = '新しい説明';
このコードは、IDが1のブックマークの説明を変更します。
これらのサンプルコードはすべて著作権フリーです。