WordPress/wp-includes/customize/class-wp-customize-background-image-control.php
Sergey Biryukov 6d0b0d9a4b Docs: Add missing documentation for some Customize class properties:
* `WP_Customize_Background_Image_Control::$type`
* `WP_Customize_Background_Image_Setting::$id`
* `WP_Customize_Header_Image_Setting::$id`

Follow-up to [21037], [21053], [30885].

Props iamjaydip.
See #55646.
Built from https://develop.svn.wordpress.org/trunk@53411


git-svn-id: http://core.svn.wordpress.org/trunk@53000 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-05-18 15:24:14 +00:00

67 lines
1.3 KiB
PHP

<?php
/**
* Customize API: WP_Customize_Background_Image_Control class
*
* @package WordPress
* @subpackage Customize
* @since 4.4.0
*/
/**
* Customize Background Image Control class.
*
* @since 3.4.0
*
* @see WP_Customize_Image_Control
*/
class WP_Customize_Background_Image_Control extends WP_Customize_Image_Control {
/**
* Customize control type.
*
* @since 4.1.0
* @var string
*/
public $type = 'background';
/**
* Constructor.
*
* @since 3.4.0
* @uses WP_Customize_Image_Control::__construct()
*
* @param WP_Customize_Manager $manager Customizer bootstrap instance.
*/
public function __construct( $manager ) {
parent::__construct(
$manager,
'background_image',
array(
'label' => __( 'Background Image' ),
'section' => 'background_image',
)
);
}
/**
* Enqueue control related scripts/styles.
*
* @since 4.1.0
*/
public function enqueue() {
parent::enqueue();
$custom_background = get_theme_support( 'custom-background' );
wp_localize_script(
'customize-controls',
'_wpCustomizeBackground',
array(
'defaults' => ! empty( $custom_background[0] ) ? $custom_background[0] : array(),
'nonces' => array(
'add' => wp_create_nonce( 'background-add' ),
),
)
);
}
}