Warning: This function has been deprecated. Use add_theme_support() instead.

add_custom_image_header() WordPress Function

The add_custom_image_header() function allows you to add a custom image to the header of your WordPress site. This image can be anything you want, and you can choose to have it displayed on the front page, or all pages of your site.

add_custom_image_header( callable $wp_head_callback, callable $admin_head_callback, callable $admin_preview_callback = '' ) #

Add callbacks for image header display.


Description

Top ↑

See also


Top ↑

Parameters

$wp_head_callback

(callable)(Required)Call on the 'wp_head' action.

$admin_head_callback

(callable)(Required)Call on custom header administration screen.

$admin_preview_callback

(callable)(Optional)Output a custom header image div on the custom header administration screen. Optional.

Default value: ''


Top ↑

Source

File: wp-includes/deprecated.php

function add_custom_image_header( $wp_head_callback, $admin_head_callback, $admin_preview_callback = '' ) {
	_deprecated_function( __FUNCTION__, '3.4.0', 'add_theme_support( \'custom-header\', $args )' );
	$args = array(
		'wp-head-callback'    => $wp_head_callback,
		'admin-head-callback' => $admin_head_callback,
	);
	if ( $admin_preview_callback )
		$args['admin-preview-callback'] = $admin_preview_callback;
	return add_theme_support( 'custom-header', $args );
}


Top ↑

Changelog

Changelog
VersionDescription
3.4.0Use add_theme_support()
2.1.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More