wppaste
WordPress

apply_filters( 'is_header_video_active', bool $show_video )

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

Compatibility

WordPress
since 4.7.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Parameters

$show_videobool
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().

Where this hook fires · 1

  • wp-includes/theme.php:1784is_header_video_active()

Source code

<?php	 * @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 );} /** * Retrieves the markup for a custom header. * * The container div will always be returned in the Customizer preview.

Changelog

Introduced in 4.7.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 6.7.7 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.