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

最終更新 : 2023年06月02日 16:59

関連

参考

Code Reference: wp_get_attachment_image

お勧め

テキストエディタの文字を変更する（2018年5月27日 更新）

テキストエディタ（投稿ページの「テキスト」タブのエディタ）に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。

query_posts（WP_Queryクラス）でカスタムフィールドを使う（2011年9月15日 更新）

先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。

更新ボタンの横にスピナーを実装する（2019年5月14日 更新）

WordPressの管理画面ではAJAXを使って何らかの処理を行う際、数秒間の空き時間にアイコンがクルクル回る「スピナー」を表示しているところがある。今作っているプラグインでこの「スピナー」を使いたくなったので、実装方法を調べてみた。

公式ディレクトリに登録するならajax.googleapis.comのライブラリは利用しない（2018年5月27日 更新）

数日前、投稿一覧ページの絞り込みドロップダウンメニューを複数選択可能にするプラグイン「Posts filter multiselect」を公開したのですが、その際に指摘されたポイントを紹介します。

Login rebuilder 2.3.0の新機能を紹介（2018年5月27日 更新）

プラグイン「Login rebuilder」はログイン時の履歴（ログ）や不正なログインページへのアクセス履歴を保存している。これらの履歴情報はダッシュボートで確認できるが、バージョン2.3.0においてそれぞれがダウンロードできるようになった。