get_header_image() – Retrieves header image for custom header.

You appear to be a bot. Output may be restricted

Description

Retrieves header image for custom header.

Usage

$string|false = get_header_image();

Parameters

Returns

string|false

Source

File name: wordpress/wp-includes/theme.php


Lines:

1 to 29 of 29
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 on GitHub View on Trac