image_downsize

説明

mixed image_downsize( int $id [ , mixed $size = 'medium' ] )
アイキャッチ画像の縮小イメージ情報を取得する。

パラメータ

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

返り値

アイキャッチ画像の指定されたサイズのイメージ情報を配列で返す。アイキャッチ画像でない場合はfalseを返す。イメージ情報の配列内容は次の通り。
配列添え字データタイプ意味
0string縮小イメージのURL
1int幅(ピクセル数)
2int高さ(ピクセル数)
3bool縮小イメージの場合は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

最終更新 : 2014年07月13日 20:26



お勧め

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

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

テーマから投稿画像のサイズを指定する(2012年3月15日 更新)

投稿記事に挿入する画像サイズは、サムネイル(150×150)、中サイズ(300×300)、大サイズ(1024×1024)がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」-「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。

さくらのVPSでKUSANAGI#2(2018年5月27日 更新)

今回は「前回」の続き。さくらのVPS(メモリー2GB SSDプラン)でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。

MOファイルを作ってみた(2018年7月25日 更新)

テーマやプラグインで使用するMOファイルはWindows環境では「Poedit」アプリを使うことが多かったが、最近では「GlotPress」のようなプラグインも増えてきており、選択肢は広がっている。定期的に開発環境を見直す過程で「Poedit」から「GlotPress」に切り替えようと思ったのだが、微妙にしっくりこなかった。

Post-tag automaton:プラグイン作ってみました(2012年12月24日 更新)

みなさんは投稿をポストする際に投稿タグを付け忘れたことはないでしょうか。このプラグインは、投稿をポストする際にタイトルと記事に投稿タグが含まれていないか調べ、含まれていた場合はその投稿タグを追加します。