WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

add_custom_background()

add_custom_background( callable $wp_head_callback = '', callable $admin_head_callback = '', callable $admin_preview_callback = '' )

In this article

Back to top

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

Add callbacks for background image display.

Description

See also

Parameters

$wp_head_callbackcallableoptional
Call on the 'wp_head' action.

Default:''

$admin_head_callbackcallableoptional
Call on custom background administration screen.

Default:''

$admin_preview_callbackcallableoptional
Output a custom background image div on the custom background administration screen. Optional.

Default:''

Source

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

View all references View on Trac View on GitHub

UsesDescription
add_theme_support()wp-includes/theme.php

Registers theme support for a given feature.

_deprecated_function()wp-includes/functions.php

Marks a function as deprecated and inform when it has been used.

Changelog

VersionDescription
3.4.0Use add_theme_support()
3.0.0Introduced.

User Contributed Notes

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