_wp_remove_unregistered_widgets( array $sidebars_widgets, array $allowed_widget_ids = array() ): array

In this article

Compares a list of sidebars with their widgets against an allowed list.

Parameters

$sidebars_widgetsarrayrequired
List of sidebars and their widget instance IDs.
$allowed_widget_idsarrayoptional
List of widget IDs to compare against. Default: Registered widgets.

Default:array()

Return

array Sidebars with allowed widgets.

Source

function _wp_remove_unregistered_widgets( $sidebars_widgets, $allowed_widget_ids = array() ) {
	if ( empty( $allowed_widget_ids ) ) {
		$allowed_widget_ids = array_keys( $GLOBALS['wp_registered_widgets'] );
	}

	foreach ( $sidebars_widgets as $sidebar => $widgets ) {
		if ( is_array( $widgets ) ) {
			$sidebars_widgets[ $sidebar ] = array_intersect( $widgets, $allowed_widget_ids );
		}
	}

	return $sidebars_widgets;
}

Changelog

VersionDescription
4.9.0Introduced.

User Contributed Notes

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