テンプレートタグ/the attachment link

説明

以下のいずれかを含んだ、添付 ファイルまたはページへのHTMLリンクを返す関数です。

1. 画像の場合、フルサイズ画像またはサムネイル。
2. 画像以外の場合は、テキストで添付のタイトル。

そのような添付が存在しない場合、関数は Missing Attachment の文字列を返します。

使い方

<?php the_attachment_link( $id, $fullsize, $deprecated, $permalink ); ?>

デフォルトの使い方

<?php the_attachment_link( 7 ); ?>

パラメータ

$id

（整数） （Optional） 所望する添付のID。

初期値： ループ で使われる場合は、現状の投稿ID。(添付だけを表示するループである必要があります)

fullsize

（boolean） （オプション） 画像の場合、オリジナルの画像 (true) またはWordPressが生成したサムネイル (false)。もし false にセットされながらもサムネイルが見つからなかった場合は、フルサイズの画像が代わりに用いられます。

初期値： 'False'

$max_dims

（配列） （Version 2.3にて廃止されました。） イメージもしくはアイコンの縦横最大値。関数によって出力されたイメージエレメント (img) の width と height に適用されます。アスペクト比は保たれます。

初期値： not used

$permalink

（boolean） （オプション） 添付ファイルもしくは画像への直リンク (Default)、または添付ページヘのリンク。

初期値： 'False'

用例

<?php

// フルサイズ画像への直リンクを表す。
the_attachment_link( 4, true );

// 添付ページヘのサムネイルリンクを表す。
the_attachment_link( 4, false, false, true );

?>

注釈

画像ではなくリンクだけが欲しい場合は、 wp_get_attachment_link() を用いてください。

変更履歴

2.0.0にて導入されました。

ソースファイル

the_attachment_link() は wp-includes/post-template.php にあります。

関連資料

添付ファイル関数: get_children(), get attached media(), the_attachment_link(), get_attachment_link(), wp_get_attachment_link(), wp_get_attachment_image(), wp_get_attachment_image_src(), wp_get_attachment_url(), wp_get_attachment_thumb_file(), wp_get_attachment_thumb_url(), is_attachment(), wp_get_attachment_metadata()

最新英語版： WordPress Codex » Function Reference/the attachment link （最新版との差分）