get_the_post_thumbnail_caption()
云策文档标注
概述
get_the_post_thumbnail_caption() 函数用于获取文章特色图像的标题。它通过 get_post_thumbnail_id() 获取图像 ID,然后调用 wp_get_attachment_caption() 返回标题字符串。
关键要点
- 函数返回文章特色图像的标题,若无标题则返回空字符串。
- 参数 $post 可选,可指定文章 ID 或 WP_Post 对象,默认为全局 $post。
- 内部依赖 get_post_thumbnail_id() 和 wp_get_attachment_caption() 函数。
- 自 WordPress 4.6.0 版本引入。
代码示例
function get_the_post_thumbnail_caption( $post = null ) {
$post_thumbnail_id = get_post_thumbnail_id( $post );
if ( ! $post_thumbnail_id ) {
return '';
}
$caption = wp_get_attachment_caption( $post_thumbnail_id );
if ( ! $caption ) {
$caption = '';
}
return $caption;
}注意事项
- 确保文章已设置特色图像,否则函数可能返回空字符串。
- 参数 $post 为 null 时,函数使用当前全局文章对象。
原文内容
Returns the post thumbnail caption.
Parameters
Source
function get_the_post_thumbnail_caption( $post = null ) {
$post_thumbnail_id = get_post_thumbnail_id( $post );
if ( ! $post_thumbnail_id ) {
return '';
}
$caption = wp_get_attachment_caption( $post_thumbnail_id );
if ( ! $caption ) {
$caption = '';
}
return $caption;
}
Changelog
| Version | Description |
|---|---|
| 4.6.0 | Introduced. |