get_the_post_thumbnail()


WordPressのget_the_post_thumbnail()関数は、投稿やページのサムネイル画像を取得するために使用されます。この関数は、投稿IDやサイズ、属性などを指定してサムネイルを表示することができます。

構文

get_the_post_thumbnail( int|WP_Post $post = null, string|array $size = 'post-thumbnail', string|array $attr = '' );

引数の説明:

  • $post(int|WP_Post) — サムネイルを取得する投稿のIDまたはWP_Postオブジェクト。デフォルトは現在の投稿。
  • $size(string|array) — サムネイルのサイズ。デフォルトは’post-thumbnail’。
  • $attr(string|array) — 画像タグに追加する属性。例えば、’alt’や’class’などを指定できます。

例1: 基本的なサムネイル表示

現在の投稿のサムネイルを表示します。

<?php echo get_the_post_thumbnail(); ?>

例2: 特定の投稿のサムネイルを表示

IDが5の投稿のサムネイルを表示します。

<?php echo get_the_post_thumbnail(5); ?>

例3: カスタムサイズのサムネイルを表示

サムネイルを’medium’サイズで表示します。

<?php echo get_the_post_thumbnail(null, 'medium'); ?>

例4: サムネイルにクラスを追加

サムネイルに’custom-class’というクラスを追加します。

<?php echo get_the_post_thumbnail(null, 'post-thumbnail', array('class' => 'custom-class')); ?>

例5: サムネイルにaltテキストを追加

サムネイルにaltテキストを追加します。

<?php echo get_the_post_thumbnail(null, 'post-thumbnail', array('alt' => 'サムネイル画像')); ?>

例6: サムネイルをリンクで囲む

サムネイルを投稿のパーマリンクで囲みます。

<?php echo '<a href="' . get_permalink() . '">' . get_the_post_thumbnail() . '</a>'; ?>

例7: サムネイルを背景画像として使用

サムネイルを背景画像として使用するためのURLを取得します。

<?php $thumbnail_url = get_the_post_thumbnail_url(null, 'large'); ?>
<div style="background-image: url('<?php echo $thumbnail_url; ?>'); width: 100%; height: 300px;"></div>

注意点:

  • サムネイルが設定されていない場合、この関数は何も返しません。
  • サイズや属性を指定する際は、WordPressのデフォルトサイズやカスタムサイズを利用できます。

関連機能：