説明
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
関連
お勧め
初期状態で「抜粋」ウィジェットを表示する（2014年1月7日 更新）
投稿編集ページのウィジェットは標準で表示されるものとされないものがある。フォーラムに『投稿の編集画面にデフォルトで抜粋を表示させたい』という投稿があったので、ちょっと調べてみた。
親子の固定ページで同じテンプレートを使う（2013年3月20日 更新）
固定ページのテンプレートファイルは「page.php」か、ページ名（スラッグ）または投稿IDを指定したテンプレートファイルになる。固定ページでページデザインが数パターンある場合、通常は「page.php」で振り分けることになるが、もう少しスマートにできないか考えてみた。全投稿を取得するのはnopaging=1でいい（2011年8月31日 更新）
query_posts関数（またはWP_Queryクラス）を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」－「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには？HTML entities button：プラグイン作ってみました（2017年12月17日 更新）
以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字（HTMLエンティティ）を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。3.2標準テーマ「Twenty Eleven」は投稿フォーマットに着目（2011年7月6日 更新）
新テーマ「Twenty Eleven」のトップページでは、投稿フォーマットに応じて表示を切り替える仕組みが提案されている。ここでは、その投稿フォームの活用方法を簡単に紹介する。