指定した添付画像(管理画面からメディアに登録された画像)のimg要素を取得する。
wp_get_attachment_image($attachment_id,$size,$icon,$attr);| 引数 | 必須/任意 | 引数に指定するもの |
|---|---|---|
| 第1引数 $attachment_id | 必須 | 画像のID (整数) |
| 第2引数 $size | 任意 | 画像サイズを下記から指定。thumbnail(設定→メディアのサムネイルサイズ)medium(設定→メディアの中サイズ)medium_large(横幅768px)large(設定→メディアの大サイズ)full(オリジナルサイズ)初期値: thumbnail(テーマ次第)あるいは配列での指定も可能。 例: [500,300](横500px、縦300pxに収める) |
| 第3引数 $icon | 任意 | 第1引数で指定したIDが画像ではない場合のフォールバックとして、アイコンを取得するかどうか。 表示する場合 true、表示しない場合false初期値: falsetrueにすると、例えばメディアにアップロードしたExcelファイルを読み込もうとするとWordPressに標準で登録されているExcelアイコンを取得します。 |
| 第4引数 $attr | 任意 | 取得するimg要素に属性を追加する文字列 / 配列で指定初期値: ''(空の文字列)例: ['class' => 'img-service', 'alt' => 'サービス概略図'] |
戻り値(返す値):指定した添付画像(管理画面からメディアに登録された画像)のimg要素
※表示するにはechoします。
img要素ではなく、画像情報(URLなど)のみを取得したい場合は、wp_get_attachment_image_src()を使います。
下記例ではID30のlargeサイズの画像にclass属性(値:img)とalt属性(値:サービス概略図)を追加して表示します。
echo wp_get_attachment_image(30, 'large', false, ['class' => 'img-service', 'alt' => 'サービス概略図']);【引数とは】
テンプレートタグ(=関数)を実行する際に、引数を渡すことができるテンプレートタグがあります。引数は、関数の中で使われるので、渡す引数の値によって実行結果が変わってきます。何を処理したいのか、どのようなデータを取得したいのかによって渡す引数が変わります。
【引数について】
※当サイトでは初期値とデフォルト値の言葉の定義を区別せず、原則統一して初期値を採用しています。