説明
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
関連
お勧め
テーブルブロックを定形に整える（2021年12月27日 更新）
ブロックエディターについて調べていると、「段落ブロックをもう少しカスタマイズした」で使ったRichTextShortcutとは別にショートカットキーを使うためのKeyboardShortcutsが見つかった。今回はこのKeyboardShortcutsを使ってテーブルブロックを定形に整える仕組みを考えてみた。
各種リンクを取得する関数一覧（2014年6月12日 更新）
サイト設計において、ページ間の相互リンクは重要である。WordPressでは各種ページのリンク（パーマリンク）を取得する関数を用意しており、それらを一通り把握しておくべきだろう。
スクリプトファイルのバージョンパラメータを変更する（2018年5月27日 更新）
Java Scriptやスタイルシートの指定を直接head要素内に記述せず、wp_enqueue_scriptsフィルターなどを使って指定する場合、WordPressのバージョン番号が付与されている。このバージョン番号は、妥当なんだろうか。
4.2の「アクティビティ」ウィジェットに投稿以外の情報も表示する（2018年5月27日 更新）
ダッシュボードの「アクティビティ」ウィジェットは「投稿（post）」の状況を表示し、固定ページ（page）やカスタム投稿タイプの投稿記事の状況については標準では表示されない。このことに対して以前『3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する』を紹介したのだが、4.2では新しいフィルターが追加され、カスタマイズが少し容易になった。
投稿一覧に「投稿フォーマット」フィルターが追加される（2019年4月12日 更新）
WordPress 5.2 Beta2（以降5.2Beta2）のソースコードを眺めていると、投稿一覧ページのフィルター機能に「投稿フォーマット」（select要素）が追加されていた。