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

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


Parameters Parameters

$sidebars_widgets

(array) (Required) List of sidebars and their widget instance IDs.

$allowed_widget_ids

(array) (Optional) List of widget IDs to compare against. Default: Registered widgets.

Default value: array()


Top ↑

Return Return

(array) Sidebars with allowed widgets.


Top ↑

Source Source

File: wp-includes/widgets.php

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


Top ↑

Changelog Changelog

Changelog
Version Description
4.9.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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