WEB制作のための情報サイト / unazuki Library

wp_get_attachment_image_src()

基本構文と使い方(引数・実行結果)

基本構文

指定した添付画像(管理画面からメディアに登録された画像)の情報を取得する。

wp_get_attachment_image_src($attachment_id,$size,$icon);

引数

引数必須/任意引数に指定するもの
第1引数
$attachment_id
必須画像のID (整数)
第2引数
$size
任意画像サイズを下記から指定。
thumbnail(設定→メディアのサムネイルサイズ)
medium(設定→メディアの中サイズ)
medium_large(横幅768px)
large(設定→メディアの大サイズ)
full(オリジナルサイズ)
初期値thumbnail(テーマ次第)

あるいは配列での指定も可能。
例:[500,300](横500px、縦300pxに収める)
第3引数
$icon
任意第1引数で指定したIDが画像ではない場合のフォールバックとして、アイコンを取得するかどうか。
表示する場合true、表示しない場合false
初期値false
trueにすると、例えばメディアにアップロードしたExcelファイルを読み込もうとするとWordPressに標準で登録されているExcelアイコンを取得します。

実行結果

戻り値(返す値):取得した画像情報の配列(第1引数で指定した画像がない場合はfalseを返す)
なお返ってきた配列は4つの要素を持ち、それぞれ以下の情報が含まれます。

$img = wp_get_attachment_image_src(30); //例:ID30の画像情報を配列で取得
$img[0] // 画像のURL
$img[1] // 画像の横幅
$img[2] // 画像の縦幅
$img[3] // リサイズされているかどうか(true/false)

例1.指定したIDの画像URLを取得する

下記例ではID30のフルサイズの画像情報からURL(インデックス0)を取得して変数に格納しています。

$img_url = wp_get_attachment_image_src(30,'full')[0]

結果例:https://example.com/wp-content/themes/my_theme/img/my-image.jpg

学習者向け補足情報

【引数とは】
テンプレートタグ(=関数)を実行する際に、引数を渡すことができるテンプレートタグがあります。引数は、関数の中で使われるので、渡す引数の値によって実行結果が変わってきます。何を処理したいのか、どのようなデータを取得したいのかによって渡す引数が変わります。

【引数について】

  • 指定できる引数の数はテンプレートタグによって異なります。(引数なしもあり)
  • 引数ごとに必須 / 任意が決まっています。(必須は必ず指定、任意は指定しなければ初期値)
  • 引数名(例:$post)は仕様の便宜上の名前と考えてください。(この名前自体はテンプレートタグ実行に関係しません。各引数に何を指定するのかを理解していればOKです。)

※当サイトでは初期値とデフォルト値の言葉の定義を区別せず、原則統一して初期値を採用しています。

関連するテンプレートタグ

テンプレートタグ 説明
get_template_directory_uri() テーマディレクトリのURLを取得します。子テーマ利用時も常に親テーマのURLを取得します。
wp_get_attachment_image() 指定した添付画像(管理画面からメディアに登録された画像)のimg要素を取得する。
get_theme_file_uri() テーマディレクトリのURLを取得します。子テーマ利用時は子テーマディレクトリのURLを取得します。
home_url() トップページのURLを取得します。