説明
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
return apply_filters( 'wp_get_attachment_image', $html, $attachment_id, $size, $icon, $attr );
/pre
アクション
実行するアクションはありません。ソースファイル
/wp-includes/media.php最終更新 : 2023年06月02日 16:59
関連
お勧め
時代はWP_Queryなのか(2011年8月1日 更新)
WordPressのテーマ作成において、メインの投稿記事とは別に特定の条件を指定した投稿内容を表示することが多々ある。つい最近まで get_posts関数を使用することが多かったのだが、最近はWP_Queryクラスを使用することが多くなってきた。3.6リリース直前チェック(2013年7月26日 更新)
$wpdbは、WordPressのデータベースにアクセスする際に使用できる便利なオブジェクト。独自テーブルの利用やデータ検索の最適化など、標準提供される関数では実現できないことを手助けしてくれる。そんな$wpdbのescapeメソッドが3.6で非推奨(deprecated)になる。テーブルブロックを投稿メタ(カスタムフィールド)に保存する(2022年1月5日 更新)
ふと「テーブルブロックの内容を投稿メタ(カスタムフィールド)として保存できたら便利なのでは」と思い、投稿メタの使い方を調べてみた。
さくらのVPSでKUSANAGI(2018年5月27日 更新)
請け負っていた業務が一段落したので、「さくらのVPS」で「KUSANAGI」を試してみました。推奨環境はメモリ4GBとなっているが、今回は実験的な利用なので、SSD 2GBプランでトライしました。
投稿画面のウェジェットを2列にする(2013年4月17日 更新)
ダッシュボード画面ではスクリーンレイアウトを最大4列まで選択できるのに、投稿画面は1列か2列のどちらか。高解像度のディスプレイを使っていると、投稿画面では大画面のメリットを生かせていない理由がここにあるのではと感じ、3列対応にしてみた。