wp_get_attachment_image

（2.5.0以降）
wp_get_attachment_image - アタッチメント情報のHTMLテキストを取得する

説明

string wp_get_attachment_image( int $attachment_id [ , mixed $size = 'thumbnail' [ , bool $icon = false [ , mixed attr = '' ] ] ] )
アタッチメント情報のHTMLテキストを取得する。

パラメータ

  • $attachment_id
    アタッチメント情報のIDを指定。
  • $size
    サイズを文字列（'thumbnail'、'post-thumbnail'、'small'、'medium'、'large'など）または配列（幅と高さのピクセル値）で指定（省略時は'thumbnail'）。
  • $icon
    アイコン画像を使用する場合はtrue、使用しない場合はfalseを指定（省略時はfalse）。
  • $attr
    添付画像の属性を文字列または連想配列で指定（省略時は''）。
    キー内容デフォルト値
    'class'class属性値（スペースで区切られたクラス名）
    'alt'alt属性値 get_post_meta（'_wp_attachment_image_alt'）からタグなどを除去したもの
    'srcset'[4.4.0]srcset属性値wp_calculate_image_srcsetの返り値
    'sizes'[4.4.0]sizes属性値wp_calculate_image_sizesの返り値
    'loading'[5.5.0]loading属性値 wp_get_loading_attr_default（'wp_get_attachment_image'）の返り値（'lazy'）
    'decoding'[6.1.0]decoding属性値'async'

返り値

アタッチメント情報が存在する場合は、そのHTMLテキストを返す。アタッチメント情報が設定されていない場合は''を返す。

注意

パラメータ$iconでtrueを指定した場合、アタッチメント情報のタイプに応じたアイコン画像（/wp-includes/images/crystal/*.png）が適用される。

使用例

  • IDが25のアタッチメント情報のHTMLテキストを取得する。
    <?php $html = wp_get_attachment_image( 25 ); ?>
  • IDが25のアタッチメント情報のHTMLテキストを幅120ピクセルと高さ80ピクセルを指定して取得する。
    <?php $html = wp_get_attachment_image( 25, array( 120, 80 ) ); ?>
  • IDが25のアタッチメント情報のHTMLテキストをclass属性を追加して取得する。
    <?php $html = wp_get_attachment_image( 25, 'post-thumbnail', false, array( 'class'=>'alignleft' ) ); ?>

フィルター

[2.8.0]パラメータ$attrを適用する前に'wp_get_attachment_image_attributes'フィルターを呼び出す。パラメータ$attrにはデフォルトの属性値が加わった連想配列が、$attachmentには添付画像の投稿情報が格納されている。 
$attr = apply_filters( 'wp_get_attachment_image_attributes', $attr, $attachment );/pre
[5.6.0]HTMLテキストを返す前に'wp_get_attachment_image'フィルターを呼び出す。パラメータ$htmlにはHTMLテキストが、$attachment_id、$size、$iconにはそれぞれ本関数が受け取った内容が、$attrには'wp_get_attachment_image_attributes'フィルターが返した内容が格納されている。 
return apply_filters( 'wp_get_attachment_image', $html, $attachment_id, $size, $icon, $attr );/pre

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/media.php

最終更新 : 2022年11月07日 10:44

関連

参考

Code Reference: wp_get_attachment_image

お勧め

Posts filter multiselect：プラグイン作ってみました（2022年4月8日 更新）

先週の金曜日、知り合いの方から「投稿一覧ページで絞り込みを行う際、複数選択できないか」といった問い合わせがあり、その時には「標準では無理ですね」と返答しました。このこと自体は事実なのですが、要するに「複数選択可能なドロップダウンメニュー」が実現できれば対応するのはそれほど難しくないような気がしました。この週末、そんなノリでちょっとコーディングしてできたのがこのプラグインです。

全投稿を取得するのはnopaging=1でいい（2011年8月31日 更新）

query_posts関数（またはWP_Queryクラス）を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」－「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには？

Contact Form 7に確認フェーズを（2012年12月16日 更新）

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript（jQuery）を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。

古めのリビジョンを削除した時のメモ（2022年5月16日 更新）

大きく育ったデータベースを整理するため、古めのリビジョンとそれに紐づいたカスタムフィールドデータを削除。と思ったら「The total number of locks exceeds the lock table size」というエラーが発生して削除できなかった。

プラグインで注意が必要な関数（2013年11月27日 更新）

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。