image_downsize:WordPress私的マニュアル

image_downsize

(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'はオリジナルの縦横比が維持される。

配列添え字	意味
'thumbnail'	150×150ピクセル
'post-thumbnail'	200×200ピクセル
'medium'	幅または高さの大きい値が300ピクセル
'large'	幅または高さの大きい値が1024ピクセル
'full'	オリジナルサイズ

取得できるのはあくまで縮小イメージになり、オリジナルサイズよりも大きなサイズは取得できない。例えば、オリジナルサイズが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

参考

Code Reference: image_downsize

お勧めコンテンツ

時代はWP_Queryなのか（2011年8月1日登録）

WordPressのテーマ作成において、メインの投稿記事とは別に特定の条件を指定した投稿内容を表示することが多々ある。つい最近までget_posts関数を使用することが多かったのだが、最近はWP_Queryクラスを使用することが多くなってきた。

各投稿記事で設定されているカスタムフィールドの値を取得するには（2011年9月16日登録）

投稿記事ごとに設定されているカスタムフィールドの値はget_post_meta関数で取得できるが、すべての投稿記事で設定されているカスタムフィールドの値を一覧を取得する関数が見当たらない。カテゴリーや投稿タグのようにそれぞれの値と実際に使用されている投稿記事件数を取得したいのだが、探し方が悪いのか見つからないのだ。

使っていないか確認しないとね！（2011年6月8日登録）

2003年に誕生したWordPress。その歴史の中には、廃止予定（deprecated）となっている関数がいくつも存在する。それらの関数をテーマやプラグインで使用するべきではないし、使用しているなら代替の関数に書き換えるべきである。ここでは~~3.2~~4.7.0現在、廃止予定となっている関数をまとめて紹介する。

子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう（2011年12月8日登録）

少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。

oEmbed対応サイトを整理した（2014年9月3日登録）

投稿記事にTwitterやYouTubeのURL（アドレス）を記述したとき、表示されるページにはリンクとしてではなく、埋め込んだURLの内容が表示される。この仕組み（機能）はoEmbedというもので、対応サイトは随時バージョンアップしている。