関数リファレンス/add image size

このページ「関数リファレンス/add image size」は $crop パラメータなどについて、情報が古くなっている可能性があります。最新版（英語）も合わせてご覧ください。最新に更新してくださる協力者を求めています。

説明

新しい画像サイズを登録する関数です。これは新しい画像がアップロードされる際に、WordPressがアイキャッチ画像 (以前はサムネイルと呼ばれていたもの) を指定した大きさで生成する時に使われます。

Note: アイキャッチ画像を有効化する、またはサムネイルを投稿するためには、使用しているテーマの functions.php に add_theme_support( 'post-thumbnails' ); が含まれていなければなりません。詳しくは「投稿サムネイル」のページも参照してください。

使い方

<?php add_image_size( $name, $width, $height, $crop ); ?>

パラメータ

$name

（string） （必須） 新しい画像サイズの名前

初期値： なし

$width

（int） （optional） 投稿サムネイルの幅をピクセル数で表すもの

初期値： 0

$height

（int） （optional） 投稿サムネイルの高さをピクセル数で表すもの

初期値： 0

$crop

（boolean） （optional） 画像の切り抜きを行うか否かを指定。False - 指定した縦または横の大きさでのリサイズ(ソフトプロポーショナル)。True - 指定した大きさでの切り抜き(ハードクロップ)。

初期値： false

予約語

thumb, thumbnail, medium, large, post-thumbnail

"thumb" と "thumbnail" はエイリアスなので、全く同一です。

詳しい説明と「なぜなのか」という背景については、 image_downsize() に詳しい記載があります。

しかし、必要ならば自らオプションを設定することができます。

update_option('thumbnail_size_w', 160);
update_option('thumbnail_size_h', 160);
update_option('thumbnail_crop', 1);

用例

テーマの functions.php ファイルの用例です。

if ( function_exists( 'add_theme_support' ) ) {
	add_theme_support( 'post-thumbnails' );
        set_post_thumbnail_size( 150, 150 ); // 初期設定の投稿サムネイル値
}

if ( function_exists( 'add_image_size' ) ) { 
	add_image_size( 'category-thumb', 300, 9999 ); //300ピクセルの幅 (高さは無制限)
	add_image_size( 'homepage-thumb', 220, 180, true ); //(切り抜かれた大きさ)
}

切り抜きモード

プロポーショナルに画像のサイズ変更をする場合 (歪ませない場合)

add_image_size( 'homepage-thumb', 220, 180 ); // 幅220ピクセル、高さ180ピクセルのソフトプロポーショナル

画像サイズを切り抜きに依って変更する場合 (横からまたは上下から)

add_image_size( 'homepage-thumb', 220, 180, true ); // 幅220ピクセル、高さ180ピクセルのハードクロップ

新しい画像サイズを使う

テーマのテンプレートファイル内での用例。

<?php if ( has_post_thumbnail() ) { the_post_thumbnail( 'category-thumb' ); } ?>

注釈

'false' の設定を行った時、もしアップロードされた画像の縦または横の大きさが新しい画像サイズと同一であった場合、アップロードディレクトリ内に新しい画像を作成することに失敗します。

変更履歴

• 2.9にて導入されました。

ソースファイル

add_image_size() は wp-includes/media.php にあります。

リソース

Regenerate Thumbnails - このプラグインは画像のサムネイルを再生成します。「設定→メディア」でサムネイルの設定を変えた後、それまでにアップロードされた画像のサムネイルを変更したい時や、異なった大きさのアイキャッチ画像を一斉に変更したい時、非常に使い勝手のよいプラグインです。

AJAX thumbnail rebuild - このプラグインはサムネイルを再生成します。アップロード済みサムネイルに対して add_image_size() を用いたい時に使えるプラグインです。(動作は遅いものの、メモリー不足エラーとなることがありません)

Simple Image Sizes - このプラグインは「メディア」パネルから直接、新しいサイズのサムネイルを生成するものです。このプラグインはまた、サムネイルの再生成も行います。このプラグインは投稿する画像サイズにサムネイルを追加し、それらを直接投稿へ追加させることができます。再生成したい大きさや投稿タイプを選ぶこともできます。

関連資料

投稿サムネイル: has_post_thumbnail, the_post_thumbnail, get_post_thumbnail_id, get_the_post_thumbnail, add_image_size(), set_post_thumbnail_size()

最新英語版： WordPress Codex » Function Reference/add image size （最新版との差分）

関数リファレンス、テンプレートタグ目次もご覧ください。