W3cubDocs

/WordPress

WP_Customize_Widgets::get_setting_id( string $widget_id ): string

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

Changelog

Version Description
3.9.0 Introduced.

© 2003–2024 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_customize_widgets/get_setting_id