the_post_thumbnail()

関数の概要

the_post_thumbnail() は、WordPressテーマ内で投稿やページのアイキャッチ画像（サムネイル画像）を表示するために使用される関数です。この関数は、ループ内やテンプレートファイル内で呼び出され、現在の投稿やページに設定されたアイキャッチ画像を画面に出力します。アイキャッチ画像は、ビジュアル的に魅力的なコンテンツを提供し、訪問者の興味を引くために役立ちます。

パラメータの説明

the_post_thumbnail( $size, $attr )

  • $size (string|array)（省略可能）：表示するサムネイル画像のサイズを指定します。デフォルトサイズは ‘post-thumbnail’ です。例えば、'thumbnail', 'medium', 'large', 'full' などの登録済みサイズや、カスタムサイズの配列（例：array(100, 100)）を指定できます。
  • $attr (array)（省略可能）：画像タグに追加する属性の配列を指定します。例えば、array('class' => 'custom-class', 'alt' => 'Custom Alt Text') のように使用します。

使用例

以下は、the_post_thumbnail() 関数を使用してデフォルトのサムネイルサイズのアイキャッチ画像を表示する基本的な例です：

<?php if ( has_post_thumbnail() ) : ?>
    <?php the_post_thumbnail(); ?>
<?php endif; ?>

特定のサイズのアイキャッチ画像を表示する例：

<?php if ( has_post_thumbnail() ) : ?>
    <?php the_post_thumbnail('medium'); ?>
<?php endif; ?>

カスタム属性を追加してアイキャッチ画像を表示する例：

<?php if ( has_post_thumbnail() ) : ?>
    <?php the_post_thumbnail('full', array('class' => 'custom-class', 'alt' => 'Custom Alt Text')); ?>
<?php endif; ?>

関連する関数

  • has_post_thumbnail(): 投稿やページにアイキャッチ画像が設定されているかどうかを確認するために使用されます。
  • get_the_post_thumbnail(): アイキャッチ画像のHTMLを取得し、返しますが、表示はしません。the_post_thumbnail() 関数と異なり、画像タグを変数に格納するために使用されます。
  • add_theme_support(): テーマにアイキャッチ画像のサポートを追加するために使用されます。この関数を使用して、テーマでアイキャッチ画像機能を有効にする必要があります。
  • set_post_thumbnail_size(): デフォルトの投稿サムネイルサイズを設定するために使用されます。

アイキャッチ画像のサポートを追加する方法

テーマにアイキャッチ画像のサポートを追加するには、テーマの functions.php ファイルに以下のコードを追加します：

function theme_setup() {
    add_theme_support('post-thumbnails');
    set_post_thumbnail_size(150, 150); // デフォルトの投稿サムネイルサイズを設定
}
add_action('after_setup_theme', 'theme_setup');

カスタム画像サイズを追加する例：

function custom_image_sizes() {
    add_image_size('custom-size', 800, 600, true); // 幅800px、高さ600pxで切り抜き
}
add_action('after_setup_theme', 'custom_image_sizes');

the_post_thumbnail() 関数を使用することで、テーマのテンプレートファイル内で投稿やページのアイキャッチ画像を簡単に表示することができます。これにより、ビジュアル的に魅力的なコンテンツを提供し、訪問者の興味を引くことができます。