wpseek.com
A WordPress-centric search engine for devs and theme authors



wp_assign_widget_to_sidebar › WordPress Function

Since5.8.0
Deprecatedn/a
› wp_assign_widget_to_sidebar ( $widget_id, $sidebar_id )
Parameters: (2)
  • (string) $widget_id The widget ID to assign.
    Required: Yes
  • (string) $sidebar_id The sidebar ID to assign to. If empty, the widget won't be added to any sidebar.
    Required: Yes
Defined at:
Codex:

Assigns a widget to the given sidebar.



Related Functions: wp_find_widgets_sidebar, wp_get_sidebar, wp_parse_widget_id, wp_list_widget_controls_dynamic_sidebar, wp_ajax_widgets_order

Source 

function wp_assign_widget_to_sidebar( $widget_id, $sidebar_id ) {
	$sidebars = wp_get_sidebars_widgets();

	foreach ( $sidebars as $maybe_sidebar_id => $widgets ) {
		foreach ( $widgets as $i => $maybe_widget_id ) {
			if ( $widget_id === $maybe_widget_id && $sidebar_id !== $maybe_sidebar_id ) {
				unset( $sidebars[ $maybe_sidebar_id ][ $i ] );
				// We could technically break 2 here, but continue looping in case the ID is duplicated.
				continue 2;
			}
		}
	}

	if ( $sidebar_id ) {
		$sidebars[ $sidebar_id ][] = $widget_id;
	}

	wp_set_sidebars_widgets( $sidebars );
}