get_adjacent_image_link

（5.8.0以降）
get_adjacent_image_link - 1つ前または次の添付ファイルへのリンクを取得する

説明

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 );