• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/previous image link

提供: WordPress Codex 日本語版
移動先: 案内検索

この項目「関数リファレンス/previous image link」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

現在の投稿に添付された前の画像へのリンクを表示します。添付ファイルのページに一連の画像がリンクされているときはいつでも、添付ファイルのページに画像と一緒に「前の画像へのリンク」を表示します。

使い方

典型的には attachment.php 内で使います。WordPress デフォルトテーマの Twenty Eleven と Twenty Twelve では、image.php 内で使われています。

<?php previous_image_link( $size, $text ); ?>

パラメータ

$size
文字列) (オプション) 画像のサイズを配列または文字列で指定。0 または none を指定するとリンクテキストが post_title(添付ファイルのタイトル)または $text になります。
初期値: 'thumbnail'
$text
文字列) (オプション) 指定すると、リンクテキストが $text の値になります。
初期値: false - 指定なし

戻り値

(void) 
何も返しません。

用例

デフォルトの使い方

<?php previous_image_link(); ?>

実用的な例

<div class="alignleft"><?php previous_image_link(); ?></div>

認識済みの画像サイズを選択

<?php previous_image_link( 'thumbnail' ); ?>
<?php previous_image_link( 'medium' ); ?>
<?php previous_image_link( 'large' ); ?>
<?php previous_image_link( 'fullsize' ); ?>

カスタム画像サイズを定義

<?php previous_image_link( array( 37, 37 ) ); ?>

第1パラメータに配列を渡しても新しい画像が作られないことに注意してください。これは web ブラウザーを使ってサムネイルを指定された寸法にフィットさせます。いざという時はこれでいいものの、ブラウザーはサイズ変更済みの画像を再サンプリングすることができないので、やや歪んだ画像が表示されます。

第1パラメータに真偽値 false を渡すと、この関数は画像のタイトルをリンクテキストに使います(メディアライブラリでセットされたもの)。

<?php previous_image_link( false ); ?>
<?php previous_image_link( 0 ); ?>

リンクテキストにカスタム文字列を指定するには、第1パラメータに真偽値 false を渡した上でカスタム文字列を第2パラメータに渡してください。

<?php previous_image_link( false, '前のイメージ' ); ?>


変更履歴

  • 新規導入: 2.5.0
  • 2.8 で、2つのパラメータを追加: $size と $text

ソースファイル

previous_image_link()wp-includes/media.php にあります。


関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function Reference/previous_image_link最新版との差分