Title: is_header_video_active
Published: December 7, 2016
Last modified: August 20, 2026

---

# is_header_video_active(): bool

## In this article

 * [Return](https://developer.wordpress.org/reference/functions/is_header_video_active()/?output_format=md#return)
 * [Source](https://developer.wordpress.org/reference/functions/is_header_video_active()/?output_format=md#source)
 * [Hooks](https://developer.wordpress.org/reference/functions/is_header_video_active()/?output_format=md#hooks)
 * [Related](https://developer.wordpress.org/reference/functions/is_header_video_active()/?output_format=md#related)
 * [Changelog](https://developer.wordpress.org/reference/functions/is_header_video_active()/?output_format=md#changelog)

[ Back to top](https://developer.wordpress.org/reference/functions/is_header_video_active()/?output_format=md#wp--skip-link--target)

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

## 󠀁[Return](https://developer.wordpress.org/reference/functions/is_header_video_active()/?output_format=md#return)󠁿

 bool True if the custom header video should be shown. False if not.

## 󠀁[Source](https://developer.wordpress.org/reference/functions/is_header_video_active()/?output_format=md#source)󠁿

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

    	/**
    	 * Filters 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 );
    }
    ```

[View all references](https://developer.wordpress.org/reference/files/wp-includes/theme.php/)
[View on Trac](https://core.trac.wordpress.org/browser/tags/7.1/src/wp-includes/theme.php#L1767)
[View on GitHub](https://github.com/WordPress/wordpress-develop/blob/7.1/src/wp-includes/theme.php#L1767-L1790)

## 󠀁[Hooks](https://developer.wordpress.org/reference/functions/is_header_video_active()/?output_format=md#hooks)󠁿

 [apply_filters( ‘is_header_video_active’, bool $show_video )](https://developer.wordpress.org/reference/hooks/is_header_video_active/)

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

## 󠀁[Related](https://developer.wordpress.org/reference/functions/is_header_video_active()/?output_format=md#related)󠁿

| Uses | Description | 
| [get_theme_support()](https://developer.wordpress.org/reference/functions/get_theme_support/)`wp-includes/theme.php` |

Gets the theme support arguments passed when registering that support.

  | 
| [apply_filters()](https://developer.wordpress.org/reference/functions/apply_filters/)`wp-includes/plugin.php` |

Calls the callback functions that have been added to a filter hook.

  |

| Used by | Description | 
| [the_custom_header_markup()](https://developer.wordpress.org/reference/functions/the_custom_header_markup/)`wp-includes/theme.php` |

Prints the markup for a custom header.

  | 
| [has_custom_header()](https://developer.wordpress.org/reference/functions/has_custom_header/)`wp-includes/theme.php` |

Checks whether a custom header is set or not.

  |

## 󠀁[Changelog](https://developer.wordpress.org/reference/functions/is_header_video_active()/?output_format=md#changelog)󠁿

| Version | Description | 
| [4.7.0](https://developer.wordpress.org/reference/since/4.7.0/) | Introduced. |

## User Contributed Notes

You must [log in](https://login.wordpress.org/?redirect_to=https%3A%2F%2Fdeveloper.wordpress.org%2Freference%2Ffunctions%2Fis_header_video_active%2F)
before being able to contribute a note or feedback.