wp_get_attachment_caption() の使い方説明・引数・注意点
wp_get_attachment_caption() は、添付ファイルのキャプションを返す関数です。
説明
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_caption() |
指定したメディアのキャプション |
get_the_post_thumbnail_caption() |
アイキャッチ画像のキャプション |
wp_get_attachment_image() |
imgタグのHTML |
PR エックスサーバー
WordPressを、速く・止まらずに運営したい方へ
サーバー選びを間違えると、表示が遅い・サイトが止まるリスクがあります
こんなお悩みはありませんか?
- どのレンタルサーバーを選べばよいか分からない
- 表示が遅い・サイトが落ちるのが心配
- WordPressの設定やセキュリティに自信がない
サーバーは、あとから乗り換えると、データの移行やドメインの設定に手間がかかります。表示が遅い、突然止まるといったトラブルは、訪問者が離れる原因にもなります。最初に、稼働率の保証や実績を確認して選ぶのが安全です。
エックスサーバーなら、WordPressの運営に強いレンタルサーバーを、迷わず選べます。国内でWordPressを利用して運用されているサイトの集計(Dataprovider.com調べ、2025年6月)で、国内シェアNo.1と公式サイトに記載されています。
選ばれるポイント
- WordPressサイトの国内シェアNo.1。実績で選びたいときの安心材料(Dataprovider.com調べ、2025年6月)
- サイトが止まりにくい。月間稼働率99.99%以上を保証し、下回ると月額費用の一部を返金
- 攻撃に強い。WordPressを狙った攻撃の99%以上を未然に防ぐ機能(2024年9月15日〜11月15日の当社調べ)
- ドメイン代を節約できる。独自ドメインが永久無料(対象ドメイン・契約期間などの条件あり)
- テーマ選びも安心。人気テーマ「Cocoon」の開発・提供元が運営
- 10日間の無料お試しで、契約前に操作や表示の速さを確かめられる
10日間の無料お試しで、契約前に試せます
10日間無料でお試し
広告(アフィリエイト)を含みます。特長は2026年11月8日時点の公式サイトの記載で、数値・順位は各調査・調べの時点のものです。料金・条件は公式サイトでご確認ください。
関連項目
wp_get_attachment_image()、get_the_post_thumbnail()、get_the_post_thumbnail_caption()
公式リファレンス:wp_get_attachment_caption() | Function | WordPress Developer Resources
本記事は情報提供を目的としています。WordPress本体やテーマ・プラグインのバージョンによって動作が異なる場合があるため、本番環境に反映する前に、必ずテスト環境で動作を確認してください。