• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/set post thumbnail size

提供: WordPress Codex 日本語版
移動先: 案内検索

アイキャッチ画像(以前は投稿サムネイル)のデフォルトの大きさを指定します。アイキャッチ画像の別のサイズを登録するには add_image_size() を使ってください。

参考: アイキャッチ画像を有効にするには、add_theme_support( 'post-thumbnails' ); をテーマの functions.php/en ファイルに含む必要があります。投稿サムネイルも見てください。

使い方

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

パラメータ

$width
整数) (オプション) アイキャッチ画像の幅。単位はピクセル。
初期値: 0
$height
整数) (オプション) アイキャッチ画像の高さ。単位はピクセル。
初期値: 0
$crop
真偽値 | 配列) (オプション) 画像を切り出すかどうか。False – 縦横比を維持して縮小; True – 指定したとおりに切り出す; 配列 – 切り出す位置を例えば array( 'top', 'left' ) のように指定。詳しくは add_image_size() を参照。
初期値: false

戻り値

この関数は値を返しません。

用例

デフォルトの使い方

テーマの functions.php/en ファイルでは次のように使います。

add_theme_support( 'post-thumbnails' );
set_post_thumbnail_size( 150, 150 );

切り出しモード

アイキャッチ画像のサイズのデフォルトを、元の画像のプロポーショナル(歪まない)なサイズ変更とするには:

set_post_thumbnail_size( 50, 50 ); // 50 pixels wide by 50 pixels tall, resize mode

アイキャッチ画像のサイズのデフォルトを、元の画像の切り出し(左右両方向または上下両方向)とするには:

set_post_thumbnail_size( 50, 50, true ); // 50 pixels wide by 50 pixels tall, crop mode

アイキャッチ画像のサイズのデフォルトを、元の画像の左上からの切り出しとするには:

set_post_thumbnail_size( 50, 50, array( 'top', 'left')  ); // 50 pixels wide by 50 pixels tall, crop from the top left corner

アイキャッチ画像のサイズのデフォルトを、元の画像の真ん中を基準とした切り出しとするには:

set_post_thumbnail_size( 50, 50, array( 'center', 'center')  ); // 50 pixels wide by 50 pixels tall, crop from the center

参考

この関数を実行しても、設定済みのアイキャッチ画像の大きさは変わりません。設定済みの画像を新しい大きさで再生成するには、Regenerate Thumbnails などのプラグインを使ってください。

変更履歴

  • 2.9 : 新規導入

ソースファイル

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

投稿サムネイル: 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/set_post_thumbnail_size最新版との差分