WP_GET_ATTACHMENT_CAPTION() │ WP 4.6.0

Функция wp_get_attachment_caption() позволяет получить подпись для указанного вложения (attachment). Важно понимать, что подпись и заголовок — это разные вещи. Не путайте их!

Используется в

Функция get_the_post_thumbnail_caption()

Время выполнения

• 1 раз — 0.000544 сек (медленно)
• 50000 раз — 0.36 сек (очень быстро)
• PHP 7.0.8, WP 4.6

Хуки функции

wp_get_attachment_caption

Возвращаемое значение

Строка или false. Функция возвращает подпись вложения при успешном выполнении или false в случае ошибки.

Как использовать

Чтобы получить подпись вложения, используйте следующую формулу:

wp_get_attachment_caption( $post_id );

• $post_id (int/WP_Post) — ID или объект WP_Post вложения.
• По умолчанию используется текущая запись.

Примеры использования

Пример 1: Получение подписи к изображению вложения

Допустим, у нас есть вложение с ID 654 и подписью "Сегодня я поймал такую большую рыбу!". Для получения этой подписи используйте следующий код:

echo wp_get_attachment_caption( 654 ); // Вывод: Сегодня я поймал такую большую рыбу!

Изменения

• С версии 4.6.0 — введена новая функция.

Код функции

Вот как выглядит код функции wp_get_attachment_caption:

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;

/**
 * Фильтрует подпись вложения.
 *
 * @since 4.6.0
 *
 * @param string $caption Подпись для данного вложения.
 * @param int    $post_id ID вложения.
 */
return apply_filters( 'wp_get_attachment_caption', $caption, $post->ID );

}

Связанные функции

Функции, которые могут быть полезны при работе с изображениями и вложениями:

• wp_attachment_is_image()
• wp_get_attachment_image()
• wp_get_attachment_image_sizes()
• wp_get_attachment_image_src()
• wp_get_attachment_image_srcset()
• wp_get_attachment_image_url()
• wp_get_attachment_thumb_url()
• wp_get_attachment_url()

Эти функции помогут вам легко манипулировать изображениями и их метаданными в WordPress.