WP_Customize_Manager::add_setting() WordPress Method
The WP_Customize_Manager::add_setting() method is used to add a new setting to the Customizer. This setting can be used to control any aspect of the Customizer, including its layout and behavior.
WP_Customize_Manager::add_setting( WP_Customize_Setting|string $id, array $args = array() ) #
Adds a customize setting.
Description
See also
Parameters
- $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.
Default value: array()
Return
(WP_Customize_Setting) The instance of the setting that was added.
Source
File: wp-includes/class-wp-customize-manager.php
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; }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
4.5.0 | Return added WP_Customize_Setting instance. |
3.4.0 | Introduced. |