is_active_widget( callable|false $callback = false, string|false $widget_id = false, string|false $id_base = false, bool $skip_inactive = true ): string|false

Description

Parameters

$callbackcallable|falseoptional

Widget callback to check. Default false.Default: false

$widget_idstring|falseoptional

Widget ID. Optional, but needed for checking. Default false.Default: false

$id_basestring|falseoptional

The base ID of a widget created by extending WP_Widget. Default false.Default: false

$skip_inactivebooloptional

Whether to check in 'wp_inactive_widgets'. Default true.Default: true

Return

string|false

ID of the sidebar in which the widget is active, false if the widget is not active.

Uses · 3

• wp_get_sidebars_widgets()Retrieve full list of sidebars and their widget instance IDs.
• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• _get_widget_id_base()Retrieves the widget ID base value.

Used by · 4

• Twenty_Fourteen_Ephemera_Widget::__construct()Constructor.
• WP_Customize_Widgets::get_available_widgets()Builds up an index of all available widgets for use in Backbone models.
• WP_Widget_Recent_Comments::__construct()Sets up a new Recent Comments widget instance.
• wp_list_widgets()Display list of the available widgets.

Source

View on Trac ↗View on GitHub ↗

914function is_active_widget( $callback = false, $widget_id = false, $id_base = false, $skip_inactive = true ) {915	global $wp_registered_widgets;916 917	$sidebars_widgets = wp_get_sidebars_widgets();918 919	if ( is_array( $sidebars_widgets ) ) {920		foreach ( $sidebars_widgets as $sidebar => $widgets ) {921			if ( $skip_inactive && ( 'wp_inactive_widgets' === $sidebar || str_starts_with( $sidebar, 'orphaned_widgets' ) ) ) {922				continue;923			}924 925			if ( is_array( $widgets ) ) {926				foreach ( $widgets as $widget ) {927					if ( ( $callback && isset( $wp_registered_widgets[ $widget ]['callback'] ) && $wp_registered_widgets[ $widget ]['callback'] === $callback ) || ( $id_base && _get_widget_id_base( $widget ) === $id_base ) ) {928						if ( ! $widget_id || $widget_id === $wp_registered_widgets[ $widget ]['id'] ) {929							return $sidebar;930						}931					}932				}933			}934		}935	}936	return false;937}

History

Introduced in 2.2.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/widgets.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.