概要
get_adjacent_image_link関数は、ワードプレスにおいて1つ前または次の添付ファイルへのリンクを取得するための関数です。この関数を使うと、特定の投稿に関連する前後の画像へのリンクを簡単に取得でき、ギャラリーやスライドショーの作成、ナビゲーションの実装などでよく利用されます。以下に、この関数がよく使われる機能の例を挙げます。
- ギャラリーのナビゲーション機能
- スライドショーの実装
- 添付ファイルの一覧の表示
- 前後の画像の切り替えボタンの作成
- メディアライブラリとの連携
- ブログ記事内のエビデンス画像の表示
- イメージポートフォリオのナビゲーション
- 記事間の関連画像の提示
構文
get_adjacent_image_link( $adjacent, $image_id, $post_id, $size );
パラメータ
- $adjacent (bool) (必須): 前の画像を取得する場合は
true、次の画像を取得する場合はfalseを指定します。 - $image_id (int) (必須): 対象となる添付ファイルのIDです。
- $post_id (int) (オプション): 現在の投稿のIDです。指定しない場合は
globalの$postから取得します。 - $size (mixed) (オプション): 取得する画像のサイズ。例:
thumbnail,medium,large。
戻り値
get_adjacent_image_linkは、前または次の画像へのHTMLの <a> タグの文字列を返します。該当する画像が存在しない場合は空文字を返します。
関連する関数
使用可能なバージョン
get_adjacent_image_link関数は、WordPress 2.5.0以降で利用可能です。
コアファイルのパス
get_adjacent_image_link関数は、wp-includes/media.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 |
非推奨または削除されたバージョン
特定のバージョンでget_adjacent_image_linkが非推奨または削除されたという情報はありません。