概要
get_next_image_link
関数は、次の添付ファイルへのリンクを取得するためのWordPressの関数です。この関数は、主に以下のような機能を実装する際によく使われます。
- ギャラリーのナビゲーションを作成する
- 画像のスライドショーを構築する
- 記事内の画像を次に進めるリンクを表示する
- 画像付きの記事のストーリーテリングを支援する
- 添付ファイルの詳細ページを作成する
- 画像のフルサイズ表示を促すリンクを生成する
- 番号付きナビゲーションの実装
- ユーザーインターフェース(UI)の向上
構文
get_next_image_link( $post_id = null, $size = 'thumbnail', $text = null, $icon = false );
パラメータ
$post_id
(int|null): 現在の投稿のID。指定しない場合は、グローバル$post
から取得されます。$size
(string): 画像のサイズ。例: ‘thumbnail’, ‘medium’, ‘large’。デフォルトは ‘thumbnail’。$text
(string|null): リンクに表示されるテキスト。デフォルトはnull
(シンプルなアイコンリンク)。$icon
(bool): アイコンを表示するかどうか。デフォルトはfalse
。
戻り値
次の添付ファイルへのリンクのHTML文字列。次の画像が存在しない場合は空の文字列を返します。
関連する関数
使用可能なバージョン
get_next_image_link
関数は、WordPress 2.0.0以降で使用可能です。
コアファイルのパス
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_next_image_link
関数は、特定のバージョンで非推奨または削除されたことはありません。