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



お勧め

カスタムフィールド関連関数のおさらい(2012年6月22日 更新)

カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。

「順序」をtextからnumberに変更してみた(2018年5月27日 更新)

固定ページの編集画面の「投稿の属性」ウィジェットには、ページの並び替えに使用できる「順序」のinput要素がある。この「順序」のinput要素はtype属性が'text'となっており、編集の際にIMEが有効になってしまう場合がある。ページの編集頻度が多くなると、その都度IMEをオフにするのがやや面倒になってくる。

Login rebuilderのログ表示機能を紹介(2018年5月27日 更新)

プラグイン「Login rebuilder」には、バージョン1.2.0からログ情報を保存・確認する機能が備わっています。このログ情報では直近のログインページへの不正アクセスやログイン試行を確認できます。ここでは保存しているログ情報の見方について簡単に説明します。

query_posts(WP_Queryクラス)でカスタムフィールドを使う(2011年9月15日 更新)

先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。

メタボックスをクラシックエディターのみで表示する(2019年1月15日 更新)

投稿画面向けにメタボックスを使ったプラグインがあり、それがブロックエディターで意図した通りに機能しなかった。この対処方法を考える過程でエディタータイプに応じてメタボックスを出し分けできる方法が見つかったので紹介したい。