Проверка активности пользовательского заголовочного видео — IS_HEADER_VIDEO_ACTIVE()

Функция IS_HEADER_VIDEO_ACTIVE() проверяет, может ли пользовательское заголовочное видео отображаться на текущей странице. Эта функция полезна, если вы хотите управлять показом видео в заголовке вашего сайта на WordPress.

Используемые функции

Эта функция используется в сочетании с другой функцией, а именно has_custom_header(), которая проверяет, установлено ли пользовательское заглавие.

Хуки функции

Функция IS_HEADER_VIDEO_ACTIVE() имеет один хук:

• is_header_video_active

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

Функция возвращает true или false:

• true: если пользовательское заголовочное видео должно отображаться.
• false: если оно не должно отображаться.

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

Для проверки, есть ли заголовочное видео и должно ли оно отображаться на текущей странице, можно использовать следующий код:

// Проверяем, есть ли заголовочное видео и нужно ли его показывать на текущей странице.
if (has_header_video() && is_header_video_active()) {
the_custom_header_markup();
// url видео - get_header_video_url()
}

Если всё в порядке, код выше выведет HTML-код видео плеера. Также будут подключены необходимые скрипты для отображения плеера внизу страницы:

    
    Пауза

Код функции

Вот как реализована функция is_header_video_active() в коде WordPress (файл wp-includes/theme.php):

function is_header_video_active() {
if (!get_theme_support('custom-header', 'video')) {
return false;
}

$video_active_cb = get_theme_support('custom-header', 'video-active-callback');

if (empty($video_active_cb) || !is_callable($video_active_cb)) {
    $show_video = true;
} else {
    $show_video = call_user_func($video_active_cb);
}

/**
 * Фильтрует, может ли пользовательское заголовочное видео отображаться на текущей странице.
 *
 * @since 4.7.0
 *
 * @param bool $show_video Должно ли отображаться пользовательское заголовочное видео. Возвращает значение
 *                         настройки темы для custom-header's video-active-callback.
 *                         Если обратного вызова нет, значение по умолчанию - это is_front_page().
 */
return apply_filters('is_header_video_active', $show_video);

}

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

Правильное использование функции is_header_video_active() зависит от нескольких других функций WordPress:

• get_custom_header_markup()
• get_header_image()
• get_header_image_tag()
• get_header_textcolor()
• get_header_video_url()
• has_custom_header()
• has_header_image()
• has_header_video()
• header_image()
• the_custom_header_markup()
• the_header_video_url()

Заключение

Функция is_header_video_active() является полезным инструментом для управления показом заголовочного видео на вашем сайте WordPress. Понимание ее работы и использование в комбинации с другими функциями поможет вам создать более динамичный и привлекательный сайт.