add_image_size() の使い方|説明・引数・注意点

説明

add_image_size() は、独自の画像サイズを登録する関数です。

基本構文

add_image_size( string $name, int $width = 0, int $height = 0, bool|array $crop = false ): void

引数

  • $name:サイズ名
  • $width:幅
  • $height:高さ
  • $crop:切り抜くか

戻り値

戻り値はありません。

使い方(サンプル)

add_action( 'after_setup_theme', function() {
	add_image_size( 'card', 400, 300, true );
} );

注意点

  • 登録後にアップロードした画像だけが対象です。既存の画像には、サムネイル再生成のプラグインなどが必要です。
  • after_setup_theme フックで呼びます。

実務での使いどころ

  • テーマで使う、独自の画像サイズ(サムネイルのカード用など)を、追加するとき。
  • レイアウトに合わせた縦横比で、画像を切り抜くとき($crop)。

よくあるミスと対処

  • after_setup_theme フックの外で呼んでいる。
  • 追加後に、既存の画像には反映されないことに、気づかない。サムネイルの再生成が必要。
  • 標準のサイズ名(thumbnail・medium・large)と、同じ名前を使っている。
  • サイズを増やしすぎて、アップロードのたびに、画像が大量に生成される。

NG例

add_image_size( 'card', 600, 400, true ); // フックの外で呼び、既存の画像にも反映されない

OK例

add_action( 'after_setup_theme', function () {
	add_image_size( 'card', 600, 400, true );
} );
// 既存の画像には、サムネイルの再生成が必要

使い分け早見表

関数 役割
add_image_size() 画像サイズを追加する
remove_image_size() 画像サイズを削除する
set_post_thumbnail_size() アイキャッチ画像のサイズを設定する

関連項目

set_post_thumbnail_size()、remove_image_size()

公式リファレンス:add_image_size() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました