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

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: ''

Uses · 2

• _deprecated_function()Marks a function as deprecated and inform when it has been used.
• add_theme_support()Registers theme support for a given feature.

Used by · 2

• twentyeleven_setup()Sets up theme defaults and registers support for various WordPress features.
• twentyten_setup()Sets up theme defaults and registers support for various WordPress features.

Source

View on Trac ↗View on GitHub ↗

3046function add_custom_background( $wp_head_callback = '', $admin_head_callback = '', $admin_preview_callback = '' ) {3047	_deprecated_function( __FUNCTION__, '3.4.0', 'add_theme_support( \'custom-background\', $args )' );3048	$args = array();3049	if ( $wp_head_callback )3050		$args['wp-head-callback'] = $wp_head_callback;3051	if ( $admin_head_callback )3052		$args['admin-head-callback'] = $admin_head_callback;3053	if ( $admin_preview_callback )3054		$args['admin-preview-callback'] = $admin_preview_callback;3055	return add_theme_support( 'custom-background', $args );3056}

History

Introduced in 3.0.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-includes/deprecated.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.