get_header_image()

Retrieve 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 ) );
}

Expand Source Code View on GitHub

Related

Uses

Uses
Uses Description
wp-includes/link-template.php: set_url_scheme()

Sets the scheme for a URL.
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()

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

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

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

Performs esc_url() for database usage.
Show 1 more use Hide more uses

Used By

Used By
Used By Description
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: get_header_video_settings()

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

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

Display header image URL.
wp-includes/theme.php: has_header_image()

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

Display first step of custom header image page.
wp-admin/includes/template.php: _media_states()
Show 2 more used by Hide more used by

Changelog

Changelog
Version Description
WP-2.1.0 Introduced.