説明
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 );/prereturn apply_filters( 'wp_get_attachment_image', $html, $attachment_id, $size, $icon, $attr );/preアクション
実行するアクションはありません。ソースファイル
/wp-includes/media.php最終更新 : 2023年06月02日 16:59
関連
お勧め
個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)
先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。
決まった値を返すだけの関数群(2018年5月27日 更新)
WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。
サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)
ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)
Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。
favicon.icoがWordPressロゴになる!?(2020年2月25日 更新)
先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。