Описание функции wp_get_attachment_caption()
Функция wp_get_attachment_caption() возвращает заголовок (caption) для вложения в WordPress. Она используется для получения дополнительной информации о медиафайлах, таких как изображения. Функция обычно применяется в темах и плагинах для отображения заголовка изображения в галереях или других местах, где используются вложения.
Функция была добавлена в WordPress версии 4.4.0 и находится в файле wp-includes/post.php.
Параметры
$attachment_id
Тип: int
Обязательный: Да
Описание: ID вложения, для которого нужно получить заголовок
Возможные значения:
Возвращаемое значение
Тип: string|null
Описание: Возвращает заголовок вложения или null, если заголовок отсутствует
Возможные значения:
• Строка с заголовком вложения
• null, если заголовок отсутствует
Примеры использования
Базовый пример получения заголовка для вложения с ID 123
$caption = wp_get_attachment_caption(123);
if ($caption) {
echo $caption;
} else {
echo 'Нет заголовка';
}
Выводит заголовок или сообщение о его отсутствии
Получение заголовков для всех вложений в цикле
$attachments = get_posts(array(
'post_type' => 'attachment',
'numberposts' => -1
));
foreach ($attachments as $attachment) {
echo wp_get_attachment_caption($attachment->ID);
}
Выводит заголовки всех вложений
Безопасность
Валидация входных данных: Параметр attachment_id проходит валидацию внутри функции
Санитизация: Функция не требует дополнительной очистки параметров
Рекомендации: При выводе заголовка используйте esc_html() для защиты от XSS
— Связанные функции
Получает альтернативный текст для вложения
Получает объект поста по ID
— Примечания
– Ограничения
Возвращает заголовок только если он установлен для вложения
– Частые проблемы
- Возвращается null, если заголовок не установлен
- Проблемы с получением заголовка могут возникнуть при неверном ID
