the_custom_header_markup()

Description

Uses · 7

• get_custom_header_markup()Retrieves the markup for a custom header.
• is_header_video_active()Checks whether the custom header video is eligible to show on the current page.
• has_header_video()Checks whether a header video is set or not.
• is_customize_preview()Whether the site is being previewed in the Customizer.
• wp_enqueue_script()Enqueues a script.
• wp_localize_script()Localizes a script.
• get_header_video_settings()Retrieves header video settings.

Source

View on Trac ↗View on GitHub ↗

1818function the_custom_header_markup() {1819	$custom_header = get_custom_header_markup();1820	if ( empty( $custom_header ) ) {1821		return;1822	}1823 1824	echo $custom_header;1825 1826	if ( is_header_video_active() && ( has_header_video() || is_customize_preview() ) ) {1827		wp_enqueue_script( 'wp-custom-header' );1828		wp_localize_script( 'wp-custom-header', '_wpCustomHeaderSettings', get_header_video_settings() );1829	}1830}

History

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 7.0.4 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.