register_default_headers() – Function

Registers a selection of default headers to be displayed by the custom header admin UI.

Parameters

$headersarrayrequired: Array of headers keyed by a string ID. The IDs point to arrays containing 'url', 'thumbnail_url', and 'description' keys.

More Information

The parameter $headers is required to merge with already registered headers.
This function is needed in order to use custom headers. The header image(s) must first be registered before using it.

Source

function register_default_headers( $headers ) {
	global $_wp_default_headers;

	$_wp_default_headers = array_merge( (array) $_wp_default_headers, (array) $headers );
}

View all references View on Trac View on GitHub

Changelog

Version	Description
3.0.0	Introduced.

Edit the file functions.php inside your theme and add the following code, replacing the images and descriptions where required.
The %s is replaced with your themes path, so place the images in your theme directory.

register_default_headers( array(
	'wheel' => array(
		'url'           => '%s/images/headers/wheel.jpg',
		'thumbnail_url' => '%s/images/headers/wheel-thumbnail.jpg',
		'description'   => __( 'Wheel', 'twentyeleven' )
	),
	'shore' => array(
		'url'           => '%s/images/headers/shore.jpg',
		'thumbnail_url' => '%s/images/headers/shore-thumbnail.jpg',
		'description'   => __( 'Shore', 'twentyeleven' )
	),
	'trolley' => array(
		'url'           => '%s/images/headers/trolley.jpg',
		'thumbnail_url' => '%s/images/headers/trolley-thumbnail.jpg',
		'description'   => __( 'Trolley', 'twentyeleven' )
	)
) );

Note: The code above was lifted from the TwentyEleven theme files.

To reference a image in a child theme (ie in the stylesheet directory), use %2$s instead of %s.

register_default_headers( array(
	'child' => array(
		'url'           => '%2$s/images/headers/child.jpg',
		'thumbnail_url' => '%2$s/images/headers/child-thumbnail.jpg',
		'description'   => __( 'Child', 'twentyeleven' )
	)
	)
) );

register_default_headers( array $headers )

In this article

Parameters

More Information

Source

Changelog

User Contributed Notes