WP_Customize_Widgets::parse_widget_setting_id( string $setting_id )

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

Parameters Parameters


(string) (Required) Widget setting ID.

Top ↑

Return Return

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

Top ↑

Source Source

File: wp-includes/class-wp-customize-widgets.php

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

Top ↑

Changelog Changelog

Version Description
3.9.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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