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



お勧め

各種リンクを取得する関数一覧(2014年6月12日 更新)

サイト設計において、ページ間の相互リンクは重要である。WordPressでは各種ページのリンク(パーマリンク)を取得する関数を用意しており、それらを一通り把握しておくべきだろう。

ログインページを変える(2014年9月12日 更新)

WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。

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

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

管理画面でツールバー(Admin bar)を非表示にする(2013年3月5日 更新)

WordPress使ってちょっと変わったサイトを構築する際、管理画面のツールバーを表示させたくないケースがある。一般に公開するサイト側であれば、 show_admin_bar関数で非表示にできるのだが、管理画面ではこれを使ってもツールバーは消えてくれない。

一定時間でログアウトする(2013年5月23日 更新)

ログイン関係を調べている関係で、 wp_set_auth_cookie関数に行き着く。ログイン画面の「ログイン状態を保持する」がチェックされた場合、クッキーの有効期限は14日間。チェックされていない場合は、ブラウザが閉じるまで常に有効となっているんだね。