On this page
WP_Customize_Widgets::get_setting_id( string $widget_id ): string
Converts a widget_id into its corresponding Customizer setting ID (option name).
Parameters
$widget_idstring Required-
Widget ID.
Return
string Maybe-parsed widget ID.
Source
File: wp-includes/class-wp-customize-widgets.php. View all references
public function get_setting_id( $widget_id ) {
$parsed_widget_id = $this->parse_widget_id( $widget_id );
$setting_id = sprintf( 'widget_%s', $parsed_widget_id['id_base'] );
if ( ! is_null( $parsed_widget_id['number'] ) ) {
$setting_id .= sprintf( '[%d]', $parsed_widget_id['number'] );
}
return $setting_id;
}
Related
Uses
| Uses | Description |
|---|---|
| WP_Customize_Widgets::parse_widget_id() wp-includes/class-wp-customize-widgets.php | Converts a widget ID into its id_base and number components. |
Used By
| Used By | Description |
|---|---|
| WP_Customize_Widgets::customize_dynamic_partial_args() wp-includes/class-wp-customize-widgets.php | Filters arguments for dynamic widget partials. |
| WP_Customize_Widgets::register_settings() wp-includes/class-wp-customize-widgets.php | Inspects the incoming customized data for any widget settings, and dynamically adds them up-front so widgets will be initialized properly. |
| WP_Customize_Widgets::call_widget_update() wp-includes/class-wp-customize-widgets.php | Finds and invokes the widget update and control callbacks. |
| WP_Customize_Widgets::customize_register() wp-includes/class-wp-customize-widgets.php | Registers Customizer settings and controls for all sidebars and widgets. |
Changelog
| Version | Description |
|---|---|
| 3.9.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_customize_widgets/get_setting_id