get_header_video_url() WordPress Function
The get_header_video_url() function is used to get the URL of the header video file.
get_header_video_url() #
Retrieves header video URL for custom header.
Description
Uses a local video if present, or falls back to an external video.
Return
(string|false) Header video URL or false if there is no video.
Source
File: wp-includes/theme.php
function get_header_video_url() { $id = absint( get_theme_mod( 'header_video' ) ); if ( $id ) { // Get the file URL from the attachment ID. $url = wp_get_attachment_url( $id ); } else { $url = get_theme_mod( 'external_header_video' ); } /** * Filters the header video URL. * * @since 4.7.3 * * @param string $url Header video URL, if available. */ $url = apply_filters( 'get_header_video_url', $url ); if ( ! $id && ! $url ) { return false; } return esc_url_raw( set_url_scheme( $url ) ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
4.7.0 | Introduced. |