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

説明

添付ファイルが存在する場合はそれを表す HTML の img 要素を、ない場合は空の文字列を返します。

使い方

<?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

（整数） （必須） 添付ファイルの ID。

初期値： なし

$size

（文字列|配列） （オプション） 画像の大きさ。キーワードとなる文字列（thumbnail, medium, large, full）、または add_image_size() で定義したカスタムサイズのキーワード、もしくは幅と高さをピクセルで指定する要素 2 つの配列、例えば array( 32, 32 )。Version 2.5 以降、このパラメータはメディアアイコンの大きさを変えることができず、常に元の大きさで表示される。

初期値： 'thumbnail'

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

$icon

（真偽値） （オプション） 添付ファイルを表すメディアアイコンを使用する。

初期値： 'False'

• 1 (True) - 使用する
• 0 (False) - 使用しない

$attr

（文字列|配列） （オプション） 属性を表すクエリ形式の文字列または配列。

初期値： 下記参照。

$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 （最新版との差分）