image_downsize:WordPress私的マニュアル

(2.5.0以降)
image_downsize - アイキャッチ画像の縮小イメージ情報を取得する

mixed image_downsize( int $id [ , mixed $size = 'medium' ] )

アイキャッチ画像の縮小イメージ情報を取得する。

$id
メディア投稿（attachment）の投稿IDを指定する。
$size
取得したいサイズ名（'thumbnail'、'post-thumbnail'、'medium'、'large'、'full'）または幅と高さの配列を指定する（省略時は'medium'）。

アイキャッチ画像の指定されたサイズのイメージ情報を配列で返す。アイキャッチ画像でない場合はfalseを返す。イメージ情報の配列内容は次の通り。

配列添え字	データタイプ	意味
0	string	縮小イメージのURL
1	int	幅（ピクセル数）
2	int	高さ（ピクセル数）
3	bool	縮小イメージの場合はtrue、オリジナルサイズの場合はfalse

標準のサイズ名とその意味は次の通り。'thumbnail'と'post-thumbnail'は正方形になり、'medium'と'large'はオリジナルの縦横比が維持される。

取得できるのはあくまで縮小イメージになり、オリジナルサイズよりも大きなサイズは取得できない。例えば、オリジナルサイズが640×480ピクセルの場合、パラメータ$sizeに'large'を指定しても取得できるのはオリジナルサイズになる。

変数$attachment_idの'medium'サイズのイメージ情報を取得する。
<?php image_downsize( $attachment_id ); ?>
変数$attachment_idの'large'サイズのイメージ情報を取得する。
<?php image_downsize( $attachment_id, 'large' ); ?>
変数$attachment_idの300×300ピクセル以下のイメージ情報を取得する。
<?php image_downsize( $attachment_id, array( 300, 300 ) ); ?>

[2.5.0]パラメータ$idがアイキャッチ画像投稿かを判定し、アイキャッチ画像投稿の場合は'image_downsize'フィルターを呼び出す。パラメータの$idと$sizeは、本関数が受け取ったパラメータの値となる。フィルター関数を使用することで独自処理後に有効な情報を返すことができる。

$out = apply_filters( 'image_downsize', false, $id, $size )

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

/wp-includes/media.php