概要
get_bookmark_field 関数は、WordPressのブックマーク（リンク）情報の要素値を取得するために使用されます。この関数は主に、WordPressのブックマーク関連の操作で役立ち、特定のフィールド情報を簡単に取得できます。以下に、この関数がよく使用されるシナリオを示します。
- プログラムによるリンク情報の管理
- 特定のリンク情報の表示
- リンクリストのカスタマイズ
- リンクの編集フォームの自動入力
- 外部リンクの情報取得
- データベースのクエリにおけるリンクフィールドの利用
- テーマやプラグインでのリンク情報の表示
- バックエンド管理画面でのリンクデータ取得
構文
get_bookmark_field( string $field, int $bookmark_id = 0 )
パラメータ
- $field (string): 取得したいフィールドの名称。
- $bookmark_id (int, optional): リンクのID。デフォルトは0。
戻り値
指定されたリンクの指定フィールドの値。該当するフィールドが存在しない場合は null を返します。
関連する関数
使用可能なバージョン
この関数はWordPress 2.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_id = 1; // リンクのID
$title = get_bookmark_field('link_name', $bookmark_id);
echo $title; // リンクのタイトルを表示
このコードは、IDが1のブックマークのタイトルを取得して表示します。
サンプル2: リンクのURLを取得する
$bookmark_id = 2; // リンクのID
$url = get_bookmark_field('link_url', $bookmark_id);
echo $url; // リンクのURLを表示
このコードは、IDが2のブックマークのURLを取得して表示します。
サンプル3: リンクの説明を取得する
$bookmark_id = 3; // リンクのID
$description = get_bookmark_field('link_description', $bookmark_id);
echo $description; // リンクの説明を表示
このコードは、IDが3のブックマークの説明を取得して表示します。
サンプル4: リンクのターゲットを取得する
$bookmark_id = 4; // リンクのID
$target = get_bookmark_field('link_target', $bookmark_id);
echo $target; // リンクのターゲット属性を表示
このコードは、IDが4のブックマークのターゲット属性を取得して表示します。
サンプル5: 存在しないフィールドを取得する
$bookmark_id = 5; // リンクのID
$custom_field = get_bookmark_field('custom_field', $bookmark_id);
if ($custom_field === null) {
echo "指定されたフィールドは存在しません。"; // フィールドが存在しない場合のメッセージ
}
このコードは、IDが5のブックマークから存在しないカスタムフィールドを取得し、存在しない場合にメッセージを表示します。