説明
mixed image_downsize( int $id [ , mixed $size = 'medium' ] )
アイキャッチ画像の縮小イメージ情報を取得する。
パラメータ
- $idメディア投稿（attachment）の投稿IDを指定する。
- $size取得したいサイズ名（'thumbnail'、'post-thumbnail'、'medium'、'large'、'full'）または幅と高さの配列を指定する（省略時は'medium'）。
返り値
アイキャッチ画像の指定されたサイズのイメージ情報を配列で返す。アイキャッチ画像でない場合はfalseを返す。イメージ情報の配列内容は次の通り。| 配列添え字 | データタイプ | 意味 |
|---|---|---|
| 0 | string | 縮小イメージのURL |
| 1 | int | 幅（ピクセル数） |
| 2 | int | 高さ（ピクセル数） |
| 3 | bool | 縮小イメージの場合は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
関連
お勧め
日本語名のユーザーを登録する（2018年5月27日 更新）
標準のログインID（ユーザー名）は、英数字と一部の記号の組み合わせで構成されている。一般的なシステムのログインIDはおおむねこんな感じだが、ふと「インターネット環境ならログインIDに日本語が使用できてもいいんじゃないか」と思い、実現できるか調べてみた。
query_posts（WP_Queryクラス）でカテゴリーを絞り込む（2011年9月14日 更新）
久しぶりに query_posts関数を見直してみると、見知らぬパラメータがいくつか追加されていた。気になったのでカテゴリー関係の指定を'tax_query'パラメータを交えて整理してみた。wp_titleからwp_get_document_titleへ（2018年5月27日 更新）
先週、WordPress 4.4 beta1（以降4.4 beta1）が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。
投稿ページでユニークなテンプレートを選択しよう（2018年5月27日 更新）
4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ（'page'）向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ（'post'）はもちろんカスタム投稿タイプのページにも適用可能になっている。
同じ名前のメタ情報をまとめて削除する（2014年3月21日 更新）
WordPressには、投稿情報、コメント情報、ユーザ情報のそれぞれを拡張できるメタ情報の仕組みが用意されている。投稿情報のメタ情報は「カスタムフィールド」として投稿画面に用意されているので投稿者自身が随時操作できるほか、テーマやプラグインからの操作も容易である。今回の中身はそんなメタ情報の一括削除の話だ。