WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp_parse_widget_id()

wp_parse_widget_id( string $id ): array

In this article

Back to top

Converts a widget ID into its id_base and number components.

Parameters

$idstringrequired
Widget ID.

Return

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

Source

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

View all references View on Trac View on GitHub

Used byDescription
WP_REST_Widgets_Controller::prepare_item_for_response()wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php

Prepares the widget for the REST response.

WP_REST_Widgets_Controller::update_item()wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php

Updates an existing widget.

WP_REST_Widgets_Controller::delete_item()wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php

Deletes a widget.

WP_REST_Widgets_Controller::save_widget()wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php

Saves the widget in the request object.

WP_REST_Widget_Types_Controller::get_widgets()wp-includes/rest-api/endpoints/class-wp-rest-widget-types-controller.php

Normalize array of widgets.

Changelog

VersionDescription
5.8.0Introduced.

User Contributed Notes

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