Adds a customize setting.
Description
See also
Parameters
$idWP_Customize_Setting|stringrequired- Customize Setting object, or ID.
$argsarrayoptional- Array of properties for the new Setting object.
See WP_Customize_Setting::__construct() for information on accepted arguments.Default:
array()
Source
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;
}
Hooks
- apply_filters( ‘customize_dynamic_setting_args’,
false|array $setting_args ,string $setting_id ) Filters a dynamic setting’s constructor args.
- apply_filters( ‘customize_dynamic_setting_class’,
string $setting_class ,string $setting_id ,array $setting_args ) Allow non-statically created settings to be constructed with custom WP_Customize_Setting subclass.
Changelog
| Version | Description |
|---|---|
| 4.5.0 | Return added WP_Customize_Setting instance. |
| 3.4.0 | Introduced. |
The
sanitize_callbackparameter needs to refer to a function that accepts at least two parameters or a variable argument length. The two parameters send to the callback are 1.) the value of the setting and 2.) the instance of WP_Customize_Setting. Using a callback that only accepts one parameter may result in a customize validation failiure upon saving or a PHP warning (see error log).