get_header_image() – Function | Developer.WordPress.org

Retrieves header image for custom header.

Return

string|false

Source

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

	/**
	 * Filters the header image URL.
	 *
	 * @since 6.1.0
	 *
	 * @param string $url Header image URL.
	 */
	$url = apply_filters( 'get_header_image', $url );

	if ( ! is_string( $url ) ) {
		return false;
	}

	$url = trim( $url );
	return sanitize_url( set_url_scheme( $url ) );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘get_header_image’, string $url ): Filters the header image URL.

Uses	Description
get_theme_support()`wp-includes/theme.php`	Gets the theme support arguments passed when registering that support.
is_random_header_image()`wp-includes/theme.php`	Checks if random header image is in use.
get_random_header_image()`wp-includes/theme.php`	Gets random header image URL from registered images in theme.
get_theme_mod()`wp-includes/theme.php`	Retrieves theme modification value for the active theme.
sanitize_url()`wp-includes/formatting.php`	Sanitizes a URL for database or redirect usage.
set_url_scheme()`wp-includes/link-template.php`	Sets the scheme for a URL.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.

Show 2 more Show less

Used by	Description
get_media_states()`wp-admin/includes/template.php`	Retrieves an array of media states from an attachment.
get_header_video_settings()`wp-includes/theme.php`	Retrieves header video settings.
get_header_image_tag()`wp-includes/theme.php`	Creates image tag markup for a custom header image.
has_header_image()`wp-includes/theme.php`	Checks whether a header image is set or not.
Custom_Image_Header::step_1()`wp-admin/includes/class-custom-image-header.php`	Displays first step of custom header image page.
_delete_attachment_theme_mod()`wp-includes/theme.php`	Checks an attachment being deleted to see if it’s a header or background image.
header_image()`wp-includes/theme.php`	Displays header image URL.

Show 2 more Show less

Changelog

Version	Description
2.1.0	Introduced.

User Contributed Notes

Skip to note 5 content

jessedyck 10 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 8You must log in to vote on the helpfulness of this note

Before using this, check out get_header_image_tag() first. That’s a new function in 4.4 that’ll return an tag including the srcset attributes for responsive images.

https://developer.wordpress.org/reference/functions/get_header_image_tag/

Log in to add feedback
Skip to note 6 content

Muhammad Ijaz Anjum 8 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 4You must log in to vote on the helpfulness of this note
```
the_custom_header_markup(); 
```
can be use in place of
[html]
<img alt="" src="<?php header_image() ; ?>" width="<?php echo get_custom_header() ->width; ?>" height="<?php echo get_custom_header() ->height; ?>">[/html]
Log in to add feedback
Skip to note 7 content

Anthony Hortin 8 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note

Related:

header_image
has_header_image

Log in to add feedback
Skip to note 8 content

Codex 10 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: -1You must log in to vote on the helpfulness of this note
Example
```
<img src="<?php echo esc_url( get_header_image() ); ?>" alt="<?php echo esc_attr( get_bloginfo( 'title' ) ) ); ?>" />
```
Log in to add feedback

get_header_image(): string|false

In this article

Return

Source

Hooks

Changelog

User Contributed Notes

get_header_image(): string|false

In this article

Return

Source

Hooks

Related

Changelog

User Contributed Notes