get_custom_header()

Get the header image data.

Contents

Description Description

Return Return

(object)

Top ↑

Source Source

File: wp-includes/theme.php 

function get_custom_header() {
	global $_wp_default_headers;

	if ( is_random_header_image() ) {
		$data = _get_random_header_data();
	} else {
		$data = get_theme_mod( 'header_image_data' );
		if ( ! $data && current_theme_supports( 'custom-header', 'default-image' ) ) {
			$directory_args        = array( get_template_directory_uri(), get_stylesheet_directory_uri() );
			$data                  = array();
			$data['url']           = vsprintf( get_theme_support( 'custom-header', 'default-image' ), $directory_args );
			$data['thumbnail_url'] = $data['url'];
			if ( ! empty( $_wp_default_headers ) ) {
				foreach ( (array) $_wp_default_headers as $default_header ) {
					$url = vsprintf( $default_header['url'], $directory_args );
					if ( $data['url'] == $url ) {
						$data                  = $default_header;
						$data['url']           = $url;
						$data['thumbnail_url'] = vsprintf( $data['thumbnail_url'], $directory_args );
						break;
					}
				}
			}
		}
	}

	$default = array(
		'url'           => '',
		'thumbnail_url' => '',
		'width'         => get_theme_support( 'custom-header', 'width' ),
		'height'        => get_theme_support( 'custom-header', 'height' ),
		'video'         => get_theme_support( 'custom-header', 'video' ),
	);
	return (object) wp_parse_args( $data, $default );
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
3.4.0 Introduced.

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/theme.php: current_theme_supports()

Checks a theme’s support for a given feature.
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_data()

Get random header image data from registered images in theme.
wp-includes/theme.php: get_theme_mod()

Retrieve theme modification value for the current theme.
wp-includes/theme.php: get_template_directory_uri()

Retrieve theme directory URI.
wp-includes/theme.php: get_stylesheet_directory_uri()

Retrieve stylesheet directory URI.
wp-includes/functions.php: wp_parse_args()

Merge user defined arguments into defaults array.
Show 3 more uses Hide more uses

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 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 schrapel —

    If you want to get the custom header with a different image size use the function get_custom_header() instead of get_header_image() as the returned object has an attachment_id value.

    $custom_header = get_custom_header();
if ( ! empty( $custom_header->attachment_id ) ) {
	$image = wp_get_attachment_image_url( $custom_header->attachment_id, 'image-size' );
}

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