WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Customize_Widgets::parse_widget_id()

WP_Customize_Widgets::parse_widget_id( string $widget_id ): array

In this article

Back to top

Converts a widget ID into its id_base and number components.

Parameters

$widget_idstringrequired
Widget ID.

Return

array Array containing a widget’s id_base and number components.

Source

public function parse_widget_id( $widget_id ) {
	$parsed = array(
		'number'  => null,
		'id_base' => null,
	);

	if ( preg_match( '/^(.+)-(\d+)$/', $widget_id, $matches ) ) {
		$parsed['id_base'] = $matches[1];
		$parsed['number']  = (int) $matches[2];
	} else {
		// Likely an old single widget.
		$parsed['id_base'] = $widget_id;
	}
	return $parsed;
}

View all references View on Trac View on GitHub

Used byDescription
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::wp_ajax_update_widget()wp-includes/class-wp-customize-widgets.php

Updates widget settings asynchronously.

WP_Customize_Widgets::get_setting_id()wp-includes/class-wp-customize-widgets.php

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

WP_Customize_Widgets::is_wide_widget()wp-includes/class-wp-customize-widgets.php

Determines whether the widget is considered “wide”.

Changelog

VersionDescription
3.9.0Introduced.

User Contributed Notes

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