функция
since 4.6.0
wp_get_attachment_caption()
Проверено на WordPress 6.9, обновлено Источник: WordPress Developer Resources.
Сигнатура
wp_get_attachment_caption( int $post_id ): string|false
Описание
Возвращает подпись для вложения.
Параметры
$post_id
int
необязательный
ID вложения. По умолчанию — ID глобального объекта $post.
Возвращаемое значение
string|false
Исходный код
wp-includes/post.php:7043
function wp_get_attachment_caption( $post_id = 0 ) {
$post_id = (int) $post_id;
$post = get_post( $post_id );
if ( ! $post ) {
return false;
}
if ( 'attachment' !== $post->post_type ) {
return false;
}
$caption = $post->post_excerpt;
/**
* Filters the attachment caption.
*
* @since 4.6.0
*
* @param string $caption Caption for the given attachment.
* @param int $post_id Attachment ID.
*/
return apply_filters( 'wp_get_attachment_caption', $caption, $post->ID );
}
История изменений
| Версия | Описание |
|---|---|
| 4.6.0 | Introduced. |

