Class Reference/WP Customize Manager/add setting
Description
Adds a new theme setting that can be customized using the Theme Customization API. This is a method of the WP_Customize_Manager() class and can only be accessed through the $wp_customize object within the customize_register action hook.
Usage
$wp_customize->add_setting($id, $args);
Parameters
- $id
- (string) (required) A unique slug-like ID for the theme setting.
- Default: None
- $args
- (array) (required) An associative array containing arguments for the setting.
- Default: None
Arguments
- default
- A default value for the setting if none is defined
- type
- Optional. Specifies the TYPE of setting this is. Options are 'option' or 'theme_mod' (defaults to 'theme_mod')
- capability
- Optional. You can define a capability a user must have to modify this setting
- transport
- Optional. This can be either 'refresh' (default) or 'postMessage'. Only set this to 'postMessage' if you are writing custom Javascript to control the Theme Customizer's live preview.
Example
Remember that this example assumes you are already working within the customize_register action hook.
$wp_customize->add_setting( 'header_color' , array(
'default' => '#000',
) );
Related
