add_custom_background()
云策文档标注
概述
add_custom_background() 是一个已弃用的 WordPress 函数,用于为主题添加自定义背景图像的回调函数。自 WordPress 3.4.0 起,推荐使用 add_theme_support('custom-background', $args) 替代。
关键要点
- 该函数已弃用,自 WordPress 3.4.0 起应改用 add_theme_support('custom-background', $args)。
- 接受三个可选参数:$wp_head_callback(在 'wp_head' 动作中调用)、$admin_head_callback(在后台管理屏幕调用)和 $admin_preview_callback(在后台预览屏幕输出自定义背景图像 div)。
- 函数内部将参数转换为数组并传递给 add_theme_support() 以注册主题支持。
代码示例
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 );
}注意事项
- 使用此函数会触发 _deprecated_function() 警告,建议更新代码以避免兼容性问题。
- 相关函数包括 add_theme_support() 和 _deprecated_function(),用于主题支持和标记弃用。
原文内容
Add callbacks for background image display.
Description
See also
Parameters
$wp_head_callbackcallablerequired-
Call on the ‘wp_head’ action.
$admin_head_callbackcallablerequired-
Call on custom background administration screen.
$admin_preview_callbackcallablerequired-
Output a custom background image div on the custom background administration screen. Optional.
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 );
}
Changelog
| Version | Description |
|---|---|
| 3.4.0 | Deprecated. Use add_theme_support() |
| 3.0.0 | Introduced. |