説明
パラメータ
- $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
関連
お勧め
サイトヘルス機能を使ってみた(2019年4月12日 更新)
先月末にWordPress 5.2 Beta1が、今日はWordPress 5.2 Beta2(以降5.2Beta2)が公開された。5.2ではブロックエディターの機能が強化され、サイトの安全性とパフォーマンス向上に役立つとされるサイトヘルス機能が追加される。
管理者ページに文言を表示する(2012年4月19日 更新)
お客様向けに管理者ページをカスタマイズする機会が増えてきている。カスタマイズするページや表示場所、表示内容によっていくつかの手段があるが、今回はページの冒頭部分に任意の文言を表示する方法を紹介する。WordPressのコーディングスタンダードとPSR-2がかみ合わない(2018年5月27日 更新)
先日パソコンのストレージを換装して開発環境を再構築。エディタのEclipseは「Neon(4.6)」から「Oxygen(4.7)」へ切り替わった。コードを書き始めるとそこはかとなく違和感があり、調べていくとPHPの「Code Style(Formatter)」が「PSR-2」に設定されていることが原因だった。
Widgets on dashboard:プラグイン作ってみました(2014年5月7日 更新)
サイトバーなどのページ構成パーツとしてウィジェットを利用し、ある程度頻繁に更新している場合、毎回ウィジェットページを表示するのはちょっとだけ面倒かも。そんなわけで、シンプルにダッシュボードで直接編集できればいいかなと思い、調べてみました。
5.7の機能拡張:投稿一覧画面向けのフィルター(2021年2月18日 更新)
昨日、予定通り公開された「WordPress 5.7 Beta 3(以降Beta 3)」。WordPressはバージョンアップ毎にアクションやフィルターが追加されており、今回のバージョンアップでは投稿一覧画面に影響を与えるフィルターが追加されていた。