get_header_image(): string|false

Return

string|false

Hooks fired · 1

One hook fires while get_header_image() runs, in this order:

1. 1
   apply_filters( get_header_image )filterline 1238 (+18 into the body)

   Filters the header image URL.

Uses · 7

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

Used by · 15

• Custom_Image_Header::step_1()Displays first step of custom header image page.
• _delete_attachment_theme_mod()Checks an attachment being deleted to see if it's a header or background image.
• get_header_image_tag()Creates image tag markup for a custom header image.
• get_header_video_settings()Retrieves header video settings.
• get_media_states()Retrieves an array of media states from an attachment.
• has_header_image()Checks whether a header image is set or not.
• header_image()Displays header image URL.
• twentyeleven_admin_header_image()Custom header image markup displayed on the Appearance > Header admin panel.
• twentyfifteen_header_style()Styles the header image and text displayed on the blog.
• twentyfourteen_admin_header_image()Create the custom header image markup displayed on the Appearance > Header screen.
• twentyfourteen_body_classes()Extend the default WordPress body classes.
• twentythirteen_admin_header_image()Output markup to be displayed on the Appearance > Header admin panel.

Source

View on Trac ↗View on GitHub ↗

1220function get_header_image() {1221	$url = get_theme_mod( 'header_image', get_theme_support( 'custom-header', 'default-image' ) );1222 1223	if ( 'remove-header' === $url ) {1224		return false;1225	}1226 1227	if ( is_random_header_image() ) {1228		$url = get_random_header_image();1229	}1230 1231	/**1232	 * Filters the header image URL.1233	 *1234	 * @since 6.1.01235	 *1236	 * @param string $url Header image URL.1237	 */1238	$url = apply_filters( 'get_header_image', $url );1239 1240	if ( ! is_string( $url ) ) {1241		return false;1242	}1243 1244	$url = trim( $url );1245	return sanitize_url( set_url_scheme( $url ) );1246}

History

Introduced in 2.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/theme.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.