WP_Customize_Widgets::parse_widget_setting_id() – Method

WP_Customize_Widgets::parse_widget_setting_id( string $setting_id ): array|WP_Error

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

Parameters

$setting_idstringrequired: Widget setting ID.

Return

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

Source

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

View all references View on Trac View on GitHub

Uses	Description
WP_Error::__construct()`wp-includes/class-wp-error.php`	Initializes the error.

Changelog

Version	Description
3.9.0	Introduced.

User Contributed Notes

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