add_image_size()


WordPress関数add_image_size()は、テーマやプラグイン内で新しいカスタム画像サイズを登録するために使用されます。この関数を使用することで、投稿やページで使用する画像のカスタムサイズを指定できます。

構文

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

引数の説明

  • $name (string) — 登録する画像サイズの名前。ユニークである必要があります。
  • $width (int) — 画像の幅（ピクセル単位）。
  • $height (int) — 画像の高さ（ピクセル単位）。
  • $crop (bool|array) — トリミング方法を指定します。trueの場合は中心からトリミングされます。配列の場合はトリミングの座標を指定します。

例 1: 基本的なカスタム画像サイズの登録

以下のコードは、幅300px、高さ200pxの画像サイズを登録します。

<?php add_image_size('custom-size', 300, 200, true); ?>

例 2: 比率を維持したリサイズ

トリミングせずに画像をリサイズする方法です。

<?php add_image_size('resize-only', 600, 0); ?>

例 3: トリミング範囲を指定

トリミング範囲を左上から始めるように設定する例です。

<?php add_image_size('custom-crop', 400, 300, array('left', 'top')); ?>

例 4: 登録した画像サイズを使用

the_post_thumbnail()関数で登録したカスタム画像サイズを使用します。

<?php the_post_thumbnail('custom-size'); ?>

例 5: カスタム画像サイズの削除

登録された画像サイズを削除するには以下のコードを使用します。

<?php remove_image_size('custom-size'); ?>

注意事項

  • 画像サイズを登録した後、regenerate thumbnailsプラグインを使用して既存の画像に適用する必要があります。
  • $name引数は他のサイズ名と衝突しないように設計してください。

関連機能：