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日 更新)

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

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

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

日本語名のユーザーを登録する(2018年5月27日 更新)

標準のログインID(ユーザー名)は、英数字と一部の記号の組み合わせで構成されている。一般的なシステムのログインIDはおおむねこんな感じだが、ふと「インターネット環境ならログインIDに日本語が使用できてもいいんじゃないか」と思い、実現できるか調べてみた。

ショートコードを使ってテーマ内の画像URLを簡単に指定する(2018年5月27日 更新)

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

HTML entities button:プラグイン作ってみました(2017年12月17日 更新)

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字(HTMLエンティティ)を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。