get_header_image()

Retrieves header image for custom header.

Return

(string|false)

Source

File: wp-includes/theme.php 

function get_header_image() {
	$url = get_theme_mod( 'header_image', get_theme_support( 'custom-header', 'default-image' ) );

	if ( 'remove-header' === $url ) {
		return false;
	}

	if ( is_random_header_image() ) {
		$url = get_random_header_image();
	}

	return esc_url_raw( set_url_scheme( $url ) );
}

Uses

Uses Description
wp-includes/theme.php: get_theme_support()

Gets the theme support arguments passed when registering that support.
wp-includes/theme.php: is_random_header_image()

Checks if random header image is in use.
wp-includes/theme.php: get_random_header_image()

Gets random header image URL from registered images in theme.
wp-includes/theme.php: get_theme_mod()

Retrieves theme modification value for the current theme.
wp-includes/formatting.php: esc_url_raw()

Performs esc_url() for database usage.
wp-includes/link-template.php: set_url_scheme()

Sets the scheme for a URL.

Used By

Used By Description
wp-admin/includes/template.php: get_media_states()

Retrieves an array of media states from an attachment.
wp-includes/theme.php: get_header_video_settings()

Retrieves header video settings.
wp-includes/theme.php: get_header_image_tag()

Creates image tag markup for a custom header image.
wp-includes/theme.php: has_header_image()

Checks whether a header image is set or not.
wp-admin/includes/class-custom-image-header.php: Custom_Image_Header::step_1()

Display first step of custom header image page.
wp-includes/theme.php: _delete_attachment_theme_mod()

Checks an attachment being deleted to see if it’s a header or background image.
wp-includes/theme.php: header_image()

Displays header image URL.

Changelog

Version Description
2.1.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_header_image