A WordPress-centric search engine for devs and theme authors



get_header_video_url ›

Since4.7.0
Deprecatedn/a
get_header_video_url ( No parameters )
Returns:
  • (string|false) Header video URL or false if there is no video.
Defined at:
Codex:

Retrieve header video URL for custom header.

Uses a local video if present, or falls back to an external video.



Source

function get_header_video_url() {
	$id = absint( get_theme_mod( 'header_video' ) );
	$url = esc_url( get_theme_mod( 'external_header_video' ) );

	if ( $id ) {
		// Get the file URL from the attachment ID.
		$url = wp_get_attachment_url( $id );
	}

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