WP_Customize_Widgets::parse_widget_setting_id()publicWP 3.9.0

Converts a widget setting ID (option path) to its id_base and number components.

Method of the class: WP_Customize_Widgets{}

No Hooks.

Return

Array|WP_Error. Array containing a widget's id_base and number components, or a WP_Error object.

Usage

$WP_Customize_Widgets = new WP_Customize_Widgets();
$WP_Customize_Widgets->parse_widget_setting_id( $setting_id );
$setting_id(string) (required)
Widget setting ID.

Changelog

Since 3.9.0 Introduced.

WP_Customize_Widgets::parse_widget_setting_id() code WP 6.5.2

public function parse_widget_setting_id( $setting_id ) {
	if ( ! preg_match( '/^(widget_(.+?))(?:\[(\d+)\])?$/', $setting_id, $matches ) ) {
		return new WP_Error( 'widget_setting_invalid_id' );
	}

	$id_base = $matches[2];
	$number  = isset( $matches[3] ) ? (int) $matches[3] : null;

	return compact( 'id_base', 'number' );
}