WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Customize_Widgets::get_setting_id()

WP_Customize_Widgets::get_setting_id( string $widget_id ): string

In this article

Back to top

Converts a widget_id into its corresponding Customizer setting ID (option name).

Parameters

$widget_idstringrequired
Widget ID.

Return

string Maybe-parsed widget ID.

Source

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;
}

View all references View on Trac View on GitHub

UsesDescription
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 byDescription
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

VersionDescription
3.9.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.