get_the_post_thumbnail_caption() の使い方｜説明・引数・注意点

説明

基本構文

get_the_post_thumbnail_caption( int|WP_Post $post = null ): string

引数

• $post：投稿IDまたはオブジェクト

戻り値

キャプションの文字列。

使い方（サンプル）

echo esc_html( get_the_post_thumbnail_caption() );

注意点

• キャプションが未設定の場合は空文字です。

実務での使いどころ

• アイキャッチ画像の「キャプション」を取得して、表示するとき。

よくあるミスと対処

• キャプションが未入力のとき、空文字が返る。確認せずに、空の枠を出力する。
• 出力するときに、エスケープしていない。
• アイキャッチ画像でないメディアのキャプションなら、wp_get_attachment_caption() を使う。

NG例

echo '<figcaption>' . get_the_post_thumbnail_caption() . '</figcaption>'; // 空のときも枠が出る

OK例

$caption = get_the_post_thumbnail_caption();
if ( $caption ) {
	echo '<figcaption>' . esc_html( $caption ) . '</figcaption>';
}

使い分け早見表

関連項目

wp_get_attachment_caption()、get_the_post_thumbnail()

公式リファレンス：get_the_post_thumbnail_caption() | Function | WordPress Developer Resources