is_header_video_active(): bool

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Return value

bool

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

Performance profile

How much work a call to is_header_video_active() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

6–24

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 27.

Plugin surface

1 hook

Third-party callbacks on 'is_header_video_active' run inside this call, and their cost is not bounded by anything here.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

What one call costs · 4 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost is_header_video_active() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while is_header_video_active() runs, in this order:

1. 1
   apply_filters( is_header_video_active )filterline 1796 (+22 into the body)

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

Uses · 2

• get_theme_support()Gets the theme support arguments passed when registering that support.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 2

• has_custom_header()Checks whether a custom header is set or not.
• the_custom_header_markup()Prints the markup for a custom header.

Source code

View on Trac ↗View on GitHub ↗

1774function is_header_video_active() {1775	if ( ! get_theme_support( 'custom-header', 'video' ) ) {1776		return false;1777	}1778 1779	$video_active_cb = get_theme_support( 'custom-header', 'video-active-callback' );1780 1781	if ( empty( $video_active_cb ) || ! is_callable( $video_active_cb ) ) {1782		$show_video = true;1783	} else {1784		$show_video = call_user_func( $video_active_cb );1785	}1786 1787	/**1788	 * Filters whether the custom header video is eligible to show on the current page.1789	 *1790	 * @since 4.7.01791	 *1792	 * @param bool $show_video Whether the custom header video should be shown. Returns the value1793	 *                         of the theme setting for the `custom-header`'s `video-active-callback`.1794	 *                         If no callback is set, the default value is that of `is_front_page()`.1795	 */1796	return apply_filters( 'is_header_video_active', $show_video );1797}

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.9.7 tag, from src/wp-includes/theme.php, 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.