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

説明

基本構文

wp_get_attachment_caption( int $post_id = 0 ): string|false

引数

• $post_id：添付ファイルのID

戻り値

キャプション。なければ空文字。

使い方（サンプル）

echo esc_html( wp_get_attachment_caption( 45 ) );

注意点

• アイキャッチ画像のキャプションは get_the_post_thumbnail_caption() でも取得できます。

実務での使いどころ

• メディアの「キャプション」を取得して、画像の下に表示するとき。

よくあるミスと対処

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

NG例

echo '<figcaption>' . wp_get_attachment_caption( $id ) . '</figcaption>'; // 空のときも枠が出る。エスケープがない

OK例

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

使い分け早見表

関連項目

wp_get_attachment_image()、get_the_post_thumbnail()、get_the_post_thumbnail_caption()

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