wpseek.com
A WordPress-centric search engine for devs and theme authors



get_header_image › WordPress Function

Since2.1.0
Deprecatedn/a
› get_header_image ( No parameters )
Returns:
  • (string|false)
Defined at:
Codex:

Retrieves header image for custom header.



Related Functions: get_header_image_tag, header_image, get_random_header_image, has_header_image, the_header_image_tag

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