Warning: This function has been deprecated. Use add_theme_support() instead.
add_custom_background() WordPress Function
The add_custom_background() function allows you to add a custom background to your WordPress site. This function takes two arguments: a callback function that defines the background image and a default color. The callback function is used to define the background image. It takes two arguments: the first argument is the name of the image file, and the second argument is an array of optional image properties. The default color is optional and can be any valid hex color code. This function can be used in conjunction with the remove_custom_background() function to remove a custom background from your WordPress site.
add_custom_background( callable $wp_head_callback = '', callable $admin_head_callback = '', callable $admin_preview_callback = '' ) #
Add callbacks for background image display.
Description
See also
Parameters
- $wp_head_callback
(callable)(Optional)Call on the 'wp_head' action.
Default value: ''
- $admin_head_callback
(callable)(Optional)Call on custom background administration screen.
Default value: ''
- $admin_preview_callback
(callable)(Optional)Output a custom background image div on the custom background administration screen. Optional.
Default value: ''
Source
File: wp-includes/deprecated.php
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 ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
3.4.0 | Use add_theme_support() |
3.0.0 | Introduced. |