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

アクション

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

ソースファイル

/wp-includes/media.php

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

関連

参考

Code Reference: get_adjacent_image_link

お勧め

任意の名前でエラーログファイルを指定する（2019年2月15日 更新）

来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。

Gutenbergでカスタムフィールドを使う（2018年8月10日 更新）

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

Slightly troublesome permalink：プラグイン作ってみました（2021年4月20日 更新）

カテゴリーを含んだパーマリンクを設定している場合、複数のカテゴリーを指定した投稿記事のパーマリンクのURLに目的のカテゴリーとは異なるカテゴリーが適用された経験はないだろうか。このプラグインは、パーマリンクに適用されるカテゴリーをコントロールし、希望通りのパーマリンクを設定します。

WP_Postオブジェクトで投稿情報を直感的に使う（2012年10月4日 更新）

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

テキストエディタの文字を変更する（2018年5月27日 更新）

テキストエディタ（投稿ページの「テキスト」タブのエディタ）に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。