WP_Customize_Setting::set_root_value() WordPress Method
The WP_Customize_Setting::set_root_value() method is used to set the root value for a Customizer setting. This is the value that will be used when the setting is not overridden by a theme or plugin.
WP_Customize_Setting::set_root_value( mixed $value ) #
Set the root value for a setting, especially for multidimensional ones.
Parameters
- $value
(mixed)(Required)Value to set as root of multidimensional setting.
Return
(bool) Whether the multidimensional root was updated successfully.
Source
File: wp-includes/class-wp-customize-setting.php
protected function set_root_value( $value ) { $id_base = $this->id_data['base']; if ( 'option' === $this->type ) { $autoload = true; if ( isset( self::$aggregated_multidimensionals[ $this->type ][ $this->id_data['base'] ]['autoload'] ) ) { $autoload = self::$aggregated_multidimensionals[ $this->type ][ $this->id_data['base'] ]['autoload']; } return update_option( $id_base, $value, $autoload ); } elseif ( 'theme_mod' === $this->type ) { set_theme_mod( $id_base, $value ); return true; } else { /* * Any WP_Customize_Setting subclass implementing aggregate multidimensional * will need to override this method to obtain the data from the appropriate * location. */ return false; } }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
4.4.0 | Introduced. |