説明
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
関連
お勧め
初期化に関連するアクションのおさらい（2013年11月27日 更新）
いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。WP_List_Tableクラスを使ってみた（2018年5月27日 更新）
WordPressの管理画面ではデータを一覧表示しているページがいくつもある。今回この仕組みを自分のプラグインでも使ってみたいと思い、調査しながらプラグインに組み込んでみた。
投稿ページでユニークなテンプレートを選択しよう（2018年5月27日 更新）
4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ（'page'）向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ（'post'）はもちろんカスタム投稿タイプのページにも適用可能になっている。
常時SSL接続に変更しました（2018年5月27日 更新）
先週末、本サイトを常時SSL接続に変更しました。本サイトは「さくらのVPS」（CentOS 6系、Apache 2.2系）上にWordPressのマルチサイト機能を使って構築しており、無償で使用できる「Let's Encrypt」を使って常時SSL接続に切り替えた手順をメモとして残しそうと思います。
テキストエディタの文字を変更する（2018年5月27日 更新）
テキストエディタ（投稿ページの「テキスト」タブのエディタ）に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。