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



お勧め

HTML編集モードに定型文ボタンを追加する(2011年6月1日 更新)

投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

3.2標準テーマ「Twenty Eleven」は投稿フォーマットに着目(2011年7月6日 更新)

新テーマ「Twenty Eleven」のトップページでは、投稿フォーマットに応じて表示を切り替える仕組みが提案されている。ここでは、その投稿フォームの活用方法を簡単に紹介する。

標準で使用できる数少ないショートコード[caption]とは(2018年5月27日 更新)

画像をアップロードして「投稿に追加」ボタンをクリックすると、投稿記事内にリンク付きのimgタグか、ショートコードのが挿入される。ここではそれらの書式を整理する。

ショートコードを含んだページを表示する前に何か処理する(2014年5月28日 更新)

固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。