Adds a customize setting.

• WP_Customize_Setting::__construct()

$id WP_Customize_Setting|string Required

Customize Setting object, or ID.

$args array Optional

Array of properties for the new Setting object.
See WP_Customize_Setting::__construct() for information on accepted arguments.

More Arguments from WP_Customize_Setting::__construct( ... $args )

Array of properties for the new Setting object.

• typestring
  Type of the setting. Default 'theme_mod'.
• capabilitystring
  Capability required for the setting. Default 'edit_theme_options'
• theme_supportsstring|string[]
  Theme features required to support the panel. Default is none.
• defaultstring
  Default value for the setting. Default is empty string.
• transportstring
  Options for rendering the live preview of changes in Customizer.
  Using 'refresh' makes the change visible by reloading the whole preview.
  Using 'postMessage' allows a custom JavaScript to handle live changes.
  Default is 'refresh'.
• validate_callbackcallable
  Server-side validation callback for the setting's value.
• sanitize_callbackcallable
  Callback to filter a Customize setting value in un-slashed form.
• sanitize_js_callbackcallable
  Callback to convert a Customize PHP setting value to a value that is JSON serializable.
• dirtybool
  Whether or not the setting is initially dirty when created.

Default: array()

WP_Customize_Setting The instance of the setting that was added.

File: wp-includes/class-wp-customize-manager.php. View all references

public function add_setting( $id, $args = array() ) {
	if ( $id instanceof WP_Customize_Setting ) {
		$setting = $id;
	} else {
		$class = 'WP_Customize_Setting';

		/** This filter is documented in wp-includes/class-wp-customize-manager.php */
		$args = apply_filters( 'customize_dynamic_setting_args', $args, $id );

		/** This filter is documented in wp-includes/class-wp-customize-manager.php */
		$class = apply_filters( 'customize_dynamic_setting_class', $class, $id, $args );

		$setting = new $class( $this, $id, $args );
	}

	$this->settings[ $setting->id ] = $setting;
	return $setting;
}