the_post_thumbnail_caption()


WordPressのthe_post_thumbnail_caption()関数は、投稿のサムネイル画像に関連付けられたキャプションを取得または表示するために使用されます。

構文

<?php the_post_thumbnail_caption(); ?>

例 1: 投稿のサムネイルキャプションを表示する

投稿のサムネイルに設定されたキャプションを表示します。

<?php if ( the_post_thumbnail_caption() ) { echo the_post_thumbnail_caption(); } ?>

例 2: キャプションが設定されている場合のみ表示する

キャプションが設定されていない場合には何も表示しません。

<?php
$caption = the_post_thumbnail_caption();
if ( $caption ) {
    echo '<div class="thumbnail-caption">' . $caption . '</div>';
}
?>

例 3: カスタムスタイルを適用する

キャプションにCSSクラスを追加してカスタムスタイルを適用します。

<?php
$caption = the_post_thumbnail_caption();
if ( $caption ) {
    echo '<span class="custom-caption">' . esc_html( $caption ) . '</span>';
}
?>

例 4: サムネイルキャプションをJSON形式で取得する

サムネイルキャプションをJSON形式でエクスポートします。

<?php
$caption = the_post_thumbnail_caption();
if ( $caption ) {
    echo json_encode( array( 'thumbnail_caption' => $caption ) );
}
?>

例 5: 投稿IDを使用してキャプションを取得する

特定の投稿IDのサムネイルキャプションを取得します。

<?php
$post_id = get_the_ID();
$caption = get_the_post_thumbnail_caption( $post_id );
if ( $caption ) {
    echo '<div>' . esc_html( $caption ) . '</div>';
}
?>

注意事項

  • the_post_thumbnail_caption()はキャプションが設定されていない場合、空の値を返します。
  • HTML出力をカスタマイズする場合、esc_html()やwp_kses()を使用してセキュリティを確保してください。
  • サムネイルが設定されていない投稿ではキャプションも存在しません。

関連機能：