get_header_image

Retrieve header image for custom header.

Description

(string|false) get_header_image();

Returns (string|false)

Usage

if ( !function_exists( 'get_header_image' ) ) { 
    require_once ABSPATH . WPINC . '/theme.php'; 
} 
 
  
// NOTICE! Understand what this does before running. 
$result = get_header_image();

Defined (1)

The function is defined in the following location(s).

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