add_custom_background

The timeline below displays how wordpress function add_custom_background has changed across different WordPress versions. If a version is not listed, refer to the next available version below.

WordPress Version: 4.6

/**
 * Add callbacks for background image display.
 *
 * @since 3.0.0
 * @deprecated 3.4.0 Use add_theme_support()
 * @see add_theme_support()
 *
 * @param callable $wp_head_callback Call on the {@see 'wp_head'} action.
 * @param callable $admin_head_callback Call on custom background administration screen.
 * @param callable $admin_preview_callback Output a custom background image div on the custom background administration screen. Optional.
 */
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);
}

WordPress Version: 4.4

/**
 * Add callbacks for background image display.
 *
 * @since 3.0.0
 * @deprecated 3.4.0 Use add_theme_support()
 * @see add_theme_support()
 *
 * @param callable $wp_head_callback Call on 'wp_head' action.
 * @param callable $admin_head_callback Call on custom background administration screen.
 * @param callable $admin_preview_callback Output a custom background image div on the custom background administration screen. Optional.
 */
function add_custom_background($wp_head_callback = '', $admin_head_callback = '', $admin_preview_callback = '')
{
    _deprecated_function(__FUNCTION__, '3.4', '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);
}

WordPress Version: 3.7

/**
 * Add callbacks for background image display.
 *
 * @since 3.0.0
 * @deprecated 3.4.0
 * @deprecated Use add_theme_support('custom-background, $args)
 * @see add_theme_support()
 *
 * @param callback $wp_head_callback Call on 'wp_head' action.
 * @param callback $admin_head_callback Call on custom background administration screen.
 * @param callback $admin_preview_callback Output a custom background image div on the custom background administration screen. Optional.
 */
function add_custom_background($wp_head_callback = '', $admin_head_callback = '', $admin_preview_callback = '')
{
    _deprecated_function(__FUNCTION__, '3.4', '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);
}