WordPress.org

get_header_image()

Retrieve header image for custom header.

Contents

Description
- Return
- Source
- Changelog
Related
- Uses
- Used By
User Contributed Notes

Description Description

Return Return

(string|false)

Source 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 full source code Collapse full source code View on Trac

Changelog Changelog

Changelog
Version	Description
2.1.0	Introduced.

Uses Uses

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()	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.
wp-includes/link-template.php: set_url_scheme()	Sets the scheme for a URL.

Show 1 more use Hide more uses

Used By Used By

Used By
Used By	Description
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: has_header_image()	Check whether a header image is set or not.
wp-admin/includes/template.php: _media_states()
wp-admin/custom-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()	Display header image URL.

Show 2 more used by Hide more used by

User Contributed Notes User Contributed Notes

Skip to note 1 content

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

Contributed by jessedyck — 3 years ago

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 2 content

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

Contributed by Anthony Hortin — 1 year ago

Related:

header_image
has_header_image

Log in to add feedback
Skip to note 3 content

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

Contributed by id4ijaz — 11 months ago
```
the_custom_header_markup(); 
```
can be use in place of
```
<img alt="" src="<?php header_image(); ?>" width="<?php echo get_custom_header()->width; ?>" height="<?php echo get_custom_header()->height; ?>">
```
Log in to add feedback
Skip to note 4 content

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

Contributed by Codex — 3 years ago
Example
```
<img src="<?php echo esc_url( get_header_image() ); ?>" alt="<?php echo esc_attr( get_bloginfo( 'title' ) ) ); ?>" />
```
Log in to add feedback

You must log in before being able to contribute a note or feedback.