説明
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
関連
お勧め
6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)
バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。
固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)
固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)
本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。
Fotepo:プラグイン作ってみました(2019年9月19日 更新)
仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。
カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)
サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。