get_adjacent_image_link

説明

string get_adjacent_image_link( [ bool $prev = true [ , string | int[] $size = 'thumbnail' [ , string | false $text = false ] ] ] )
1つ前または次の添付ファイルへのリンクを取得する。

パラメータ

  • $prev
    1つ前の添付ファイルの場合はtrueを、次の添付ファイルの場合はfalseを指定(省略時はtrue)
  • $size
    サイズとして'thumbnail'、'none'または数値の配列(幅、高さ)を指定(省略時は'thumbnail')
  • $text
    見出し文字を指定(省略時はfalse)

返り値

パラメータ$prevで指定された添付ファイルへのリンクを返す。該当する添付ファイルがない場合は''を返す。

注意

get_previous_image_linkおよび get_next_image_link関数から呼び出される。

添付ファイルの並び順は、優先度がmenu_order、IDの順で、それぞれ昇順となる。

'previous_image_link'フィルターと'next_image_link'フィルターは、本関数に移動している。該当する添付ファイルがない場合はパラメータ$outputには''が、$attachment_idには0が格納される。


使用例

  • 1つ前の添付ファイルへのリンクを取得する。
    $link = get_adjacent_image_link( true );
  • 次の添付ファイルへのリンクを取得する。
    $link = get_adjacent_image_link( false );

フィルター

[3.5.0]パラメータ$prevがtrueの場合にリンクを返す直前に'previous_image_link'フィルターを呼び出す。パラメータ$outputにはリンクのテキストが、$attachment_idには対象となる添付ファイルの投稿IDが、$size$textは本関数が受け取った内容が格納される。
return apply_filters( "previous_image_link", $output, $attachment_id, $size, $text );
[3.5.0]パラメータ$prevがfalseの場合にリンクを返す直前に'next_image_link'フィルターを呼び出す。パラメータ$outputにはリンクのテキストが、$attachment_idには対象となる添付ファイルの投稿IDが、$size$textは本関数が受け取った内容が格納される。
return apply_filters( "next_image_link", $output, $attachment_id, $size, $text );

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/media.php

最終更新 : 2021年07月25日 13:57



お勧め

子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう(2011年12月8日 更新)

少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。

管理画面の'アイキャッチ画像'を'写真'に変える(2013年1月23日 更新)

クライアント向けに専用のテーマを提供する際、稀に管理画面内の用語の変更を依頼されることがある。今回は、'アイキャッチ画像'だとわかりにくいので'写真'に変えてほしいということだった。

5.7の機能拡張:投稿一覧画面向けのフィルター(2021年2月18日 更新)

昨日、予定通り公開された「WordPress 5.7 Beta 3(以降Beta 3)」。WordPressはバージョンアップ毎にアクションやフィルターが追加されており、今回のバージョンアップでは投稿一覧画面に影響を与えるフィルターが追加されていた。

Login rebuilder 2.6.0の新機能紹介(2019年4月22日 更新)

今回追加したものは、REST API / Usersの使用をログイン時のみ使用できるように制限する機能である。この機能を有効にすることで、管理者情報が漏洩するリスクを低減させる効果が期待できる。

タイトルのみをキーワード検索する(2014年4月3日 更新)

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。