wp_get_attachment_image() の使い方|説明・引数・注意点

説明

wp_get_attachment_image() は、画像の img タグを返す関数です。srcsetなども自動で付与されます。

基本構文

wp_get_attachment_image( int $attachment_id, string|int[] $size = 'thumbnail', bool $icon = false, string|array $attr = '' ): string

引数

  • $attachment_id:添付ファイルのID
  • $size:サイズ
  • $icon:アイコンとして扱うか
  • $attr:追加する属性

戻り値

img タグの文字列。

使い方(サンプル)

echo wp_get_attachment_image( 45, 'large', false, array( 'class' => 'hero' ) );

注意点

  • alt はメディアライブラリの値が使われます。
  • レスポンシブ画像用の srcset / sizes が自動で付きます。

実務での使いどころ

  • 添付ファイルのIDから、<img> タグを出力するとき(srcset・sizes・width・height が自動で付く)。
  • alt やクラスなどを、配列で指定して出力するとき。

よくあるミスと対処

  • echo し忘れる。この関数は、HTMLを返すだけ。
  • 存在しないIDでは、空文字が返る。
  • alt を指定せず、メディアの代替テキストが空のまま。必要なら、$attr で指定する。
  • サイズ名を省略している。既定は thumbnail。

NG例

wp_get_attachment_image( $id, 'medium' ); // 返すだけで、出力されない

OK例

echo wp_get_attachment_image( $id, 'medium', false, array(
	'class' => 'thumb',
	'alt'   => '商品の写真',
) );

使い分け早見表

やりたいこと 使うもの
imgタグのHTMLを取得 wp_get_attachment_image()
URLと、幅・高さを取得 wp_get_attachment_image_src()
元のファイルのURL wp_get_attachment_url()

関連項目

wp_get_attachment_image_src()、get_the_post_thumbnail()

公式リファレンス:wp_get_attachment_image() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました