テンプレートタグ/wp get attachment image

説明

添付が存在する場合は、添付ファイルのページにHTMLの画像エレメントを、無い場合は空の文字列を返します。

使い方

<?php wp_get_attachment_image( $attachment_id, $size, $icon, $attr ); ?>

デフォルトの使い方

<?php echo wp_get_attachment_image( 1 ); ?>

もし添付が画像である場合、指定されたサイズの画像を返します。 その他の添付の場合、$icon パラメーターが true に指定されている場合、関数はメディアアイコンを返します。

テンプレートの中に添付IDをダイナミックに取得する場合は、 get_posts('post_type=attachment') などを用います。

パラメータ

$attachment_id

（integer） （必須） 所望する添付のID。

初期値： なし

$size

（文字列または配列） （Optional） 画像の大きさ。キーワードとなる文字列 (thumbnail, medium, large, full)または2つのアイテムを持つ配列が幅と高さをピクセルで、array(32,32)という形で表します。Version 2.5以降、このパラメーターはメディアアイコンの大きさを変えることができなくなりました。これは常に元の大きさで表示されるためです。

初期値： 'thumbnail'

全ての画像サイズをチェックする必要がある文字列の代わりに、add_image_size を用いてサイズを登録することを考慮すると良いでしょう。これによって切り抜かれた版が生成されます。これは、最も近いサイズの画像を探すより、遥かに効率的なやり方です。

$icon

（boolean） （Optional） 添付を表すメディアアイコンを使用する。

初期値： 'False'

• 1 (True)
• 0 (False) - デフォルト

$attr

（属性の文字列または配列） （Optional） 検索文字列または配列

初期値： なし

$default_attr = array(
	'src'	=> $src,
	'class'	=> "attachment-$size",
	'alt'   => trim(strip_tags( get_post_meta($attachment_id, '_wp_attachment_image_alt', true) )),
);

$attrの引数はWordPressのデフォルト引数に統合され、wp_get_attachment_image_attributesフィルタを通して渡されます。

用例

全ての画像をリストとして表示する場合

ページに添付されている全ての画像とタイトルを表示し、箇条書きのリストとして表示する場合は、以下を用います。

<ul>
<?php if ( have_posts() ) : while ( have_posts() ) : the_post();    

 $args = array(
   'post_type' => 'attachment',
   'numberposts' => -1,
   'post_status' => null,
   'post_parent' => $post->ID
  );

  $attachments = get_posts( $args );
     if ( $attachments ) {
        foreach ( $attachments as $attachment ) {
           echo '<li>';
           echo wp_get_attachment_image( $attachment->ID, 'full' );
           echo '<p>';
           echo apply_filters( 'the_title', $attachment->post_title );
           echo '</p></li>';
          }
     }

 endwhile; endif; ?>
</ul>

戻り値

HTMLのimgエレメントもしくは、失敗した場合は空の文字列が返されます。

変更履歴

2.5.0にて導入されました。

ソースファイル

wp_get_attachment_image() は wp-includes/media.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/wp get attachment image （最新版との差分）