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を返す。イメージ情報の配列内容は次の通り。
配列添え字データタイプ意味
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

関連

お勧めコンテンツ

全投稿を取得するのはnopaging=1でいい(2011年8月29日 登録)

query_posts関数(またはWP_Queryクラス)を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」-「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには?

投稿日の検索が自由自在に(2013年10月30日 登録)

WordPress 3.7.0ではWP_Date_Queryクラスが追加され、WP_Queryクラス(もちろんquery_posts関数でも)で利用できるようになった。このWP_Date_Queryにより、○年○月○日以前や以降の投稿情報を取得したり、○年○月○日から○年○月○日の範囲の投稿情報を取得したりといったことが、容易に行えるようになった。

the_date関数で投稿日を確実に表示する(2011年12月20日 登録)

投稿記事の投稿日時を表示する際、the_date関数を使用することが多いだろう。このthe_date関数はphpのdate関数と同じパラメータを指定することで、好みの日時フォーマットで投稿日時を表示できるのだが、ある条件の場合に投稿日時を表示しない。最初にこの現象に遭遇したときは、ちょっと悩まされた。

購読者は管理者ページのアクセス禁止(2013年11月12日 登録)

購読者(subscriber)は、通常「ダッシュボード」「プロフィール」にアクセスできるが、今回はプロフィールを独自に管理する準備を兼ねて、これらのページにアクセスできないようにブロックしてみた。

Contact Form 7に確認フェーズを(2011年12月12日 登録)

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。

最終更新日時 : 2014-07-13 20:26