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

説明

set_post_thumbnail_size() は、アイキャッチ画像の標準サイズを設定する関数です。

基本構文

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

引数

  • $width:幅
  • $height:高さ
  • $crop:切り抜くか

戻り値

戻り値はありません。

使い方(サンプル)

set_post_thumbnail_size( 800, 450, true );

注意点

  • add_theme_support( 'post-thumbnails' ) が前提です。

実務での使いどころ

  • アイキャッチ画像(post-thumbnail)の、サイズを設定するとき。

よくあるミスと対処

  • add_theme_support( 'post-thumbnails' ) を呼んでいない。サイズの登録はされるが、アイキャッチ画像の機能が、有効にならない。
  • 変更後に、既存の画像には反映されないことに、気づかない。サムネイルの再生成が必要。
  • after_setup_theme フックの外で呼んでいる。

NG例

set_post_thumbnail_size( 1200, 630, true ); // サポートの宣言がない

OK例

add_action( 'after_setup_theme', function () {
	add_theme_support( 'post-thumbnails' );
	set_post_thumbnail_size( 1200, 630, true );
} );

使い分け早見表

関数 役割
set_post_thumbnail_size() アイキャッチ画像のサイズを設定する
add_image_size() 任意の名前の、画像サイズを追加する
the_post_thumbnail() アイキャッチ画像を出力する

関連項目

add_image_size()、the_post_thumbnail()

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

コメント

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