is_header_video_active() WP 1.0

Checks whether the custom header video is eligible to show on the current page.

Hooks in function

Return

true/false. True if the custom header video should be shown. False if not.

Usage

is_header_video_active();

Code of is header video active: wp-includes/theme.php ^{VER 5.1.1}

<?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 );
	}

	/**
	 * Modify whether the custom header video is eligible to show on the current page.
	 *
	 * @since 4.7.0
	 *
	 * @param bool $show_video Whether the custom header video should be shown. Returns the value
	 *                         of the theme setting for the `custom-header`'s `video-active-callback`.
	 *                         If no callback is set, the default value is that of `is_front_page()`.
	 */
	return apply_filters( 'is_header_video_active', $show_video );
}

Related Functions

From tag: custom_header (theme options: video color image)

More from tag: Conditional tags (all)

More from category: Other Theme Functions