wp_get_attachment_image_src:WordPress私的マニュアル

wp_get_attachment_image_src

(2.5.0以降)
wp_get_attachment_image_src - 添付ファイルの表示用データを取得する

説明

mixed wp_get_attachment_image_src( int $attachment_id [ , mixed $size = 'thumbnail' [ , bool $icon = false ] ] )

添付ファイルの表示用データを取得する。

パラメータ

$attachment_id
添付ファイルIDを指定
$size
サイズを文字列（'thumbnail'、'post-thumbnail'、'small'、'medium'、'large'など）または配列（幅と高さのピクセル値）で指定（省略時は'thumbnail'）。
$icon
アイコン画像を使用する場合はtrue、使用しない場合はfalseを指定（省略時はfalse）

返り値

添付ファイルの表示用データを配列で返す。配列は、イメージファイルのURL、幅、高さの順に格納されている。表示用データを取得できなかった場合はfalseを返す。

注意

添付ファイルが画像ファイルの場合とそれ以外のデータファイルの場合では振る舞いが異なる。画像ファイルの場合は、アップロード時に指定した表示用イメージの情報を取得でき、4番目の要素には縮小イメージ（true）か元イメージ（false）かを示す。画像ファイル以外の場合は、/wp-includes/images/crystalにあるアイコン（アーカイブ、音楽、動画、文書、テキストなど）の情報を取得できる。

使用例

画像ファイルの添付ファイルIDが100の表示用データを取得する。
<?php $data = wp_get_attachment_image_src( 100 ); ?>
画像ファイル以外の添付ファイルIDが200の表示用アイコンのデータを取得する。
<?php $data = wp_get_attachment_image_src( 100, 'none', true ); ?>

フィルター

[2.5.0]パラメータ$attachment_idでイメージ情報が取得できず$iconがtrueの場合にicon_dirフィルターを呼び出す。パラメータ$icon_dirは'/wp-includes/images/media'ディレクトリのフルパス名が格納されている。

$icon_dir = apply_filters( 'icon_dir', $icon_dir );

[4.3.0]取得したイメージ情報を返す直前にwp_get_attachment_image_srcフィルターをを呼び出す。パラメータ$imageはイメージ情報が、その他のパラメータには本関数が受け取った内容が格納される。

return apply_filters( 'wp_get_attachment_image_src', $image, $attachment_id, $size, $icon );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/media.php

参考

Code Reference: wp_get_attachment_image_src