get_the_post_thumbnail_caption()


WordPressのget_the_post_thumbnail_caption()関数は、投稿のアイキャッチ画像に設定されたキャプションを取得するために使用されます。

構文

get_the_post_thumbnail_caption( int|WP_Post $post = null );
  • $post(int|WP_Post) — キャプションを取得したい投稿のIDまたはWP_Postオブジェクト。デフォルトは現在の投稿。

例1: アイキャッチ画像のキャプションを表示

この例では、現在の投稿のアイキャッチ画像のキャプションを表示します。

<?php echo get_the_post_thumbnail_caption(); ?>

例2: 特定の投稿のアイキャッチ画像キャプションを表示

この例では、指定した投稿IDのアイキャッチ画像キャプションを表示します。

<?php echo get_the_post_thumbnail_caption( get_post( 123 ) ); ?>

例3: キャプションが存在しない場合の処理

キャプションが存在しない場合に代替テキストを表示します。

<?php $caption = get_the_post_thumbnail_caption(); echo $caption ? $caption : 'キャプションがありません'; ?>

例4: キャプションを変数に格納

キャプションを変数に格納して後で使用します。

<?php $caption = get_the_post_thumbnail_caption(); ?>

例5: キャプションをフィルタリング

キャプションを取得する前にフィルタを適用します。

<?php echo apply_filters( 'the_post_thumbnail_caption', get_the_post_thumbnail_caption() ); ?>

例6: キャプションをHTMLタグで囲む

キャプションをHTMLタグで囲んで表示します。

<?php echo '<div class="caption">' . get_the_post_thumbnail_caption() . '</div>'; ?>

例7: キャプションを条件付きで表示

キャプションが存在する場合のみ表示します。

<?php if ( get_the_post_thumbnail_caption() ) { echo '<p>' . get_the_post_thumbnail_caption() . '</p>'; } ?>

例8: キャプションをショートコード内で使用

ショートコード内でキャプションを取得して表示します。

function my_caption_shortcode() { return get_the_post_thumbnail_caption(); } add_shortcode( 'my_caption', 'my_caption_shortcode' );

注意点

  • キャプションが設定されていない場合、関数は空の文字列を返します。
  • 投稿にアイキャッチ画像が設定されていない場合、この関数は動作しません。

関連機能：