WordPress at a glance

is_active_widget() WP 1.0

Whether widget is displayed on the front end.

Either $callback or $id_base can be used $id_base is the first argument when extending WP_Widget class Without the optional $widget_id parameter, returns the ID of the first sidebar in which the first instance of the widget with the given callback or $id_base is found. With the $widget_id parameter, returns the ID of the sidebar where the widget with that callback/$id_base AND that ID is found.

NOTE: $widget_id and $id_base are the same for single widgets. To be effective this function has to run after widgets have initialized, at action 'init' or later.

For more information on this and similar theme functions, check out the Conditional Tags article in the Theme Developer Handbook.

✈ 1 time = 0.000019s = very fast | 50000 times = 0.06s = speed of light | PHP 7.0.8, WP 4.7

No Hooks.

Return

String/false. False if widget is not active or id of sidebar in which the widget is active.

Usage

is_active_widget( $callback, $widget_id, $id_base, $skip_inactive );
$callback(string/false)
Widget callback to check.
Default: false
$widget_id(int/false)
Widget ID. Optional, but needed for checking.
Default: false
$id_base(string/false)
The base ID of a widget created by extending WP_Widget.
Default: false
$skip_inactive(true/false)
Whether to check in 'wp_inactive_widgets'.
Default: true

Notes

  • Global. Array. $wp_registered_widgets

Changelog

Since 2.2.0 Introduced.

Code of is active widget: wp-includes/widgets.php WP 5.2.4

<?php
function is_active_widget( $callback = false, $widget_id = false, $id_base = false, $skip_inactive = true ) {
	global $wp_registered_widgets;

	$sidebars_widgets = wp_get_sidebars_widgets();

	if ( is_array( $sidebars_widgets ) ) {
		foreach ( $sidebars_widgets as $sidebar => $widgets ) {
			if ( $skip_inactive && ( 'wp_inactive_widgets' === $sidebar || 'orphaned_widgets' === substr( $sidebar, 0, 16 ) ) ) {
				continue;
			}

			if ( is_array( $widgets ) ) {
				foreach ( $widgets as $widget ) {
					if ( ( $callback && isset( $wp_registered_widgets[ $widget ]['callback'] ) && $wp_registered_widgets[ $widget ]['callback'] == $callback ) || ( $id_base && _get_widget_id_base( $widget ) == $id_base ) ) {
						if ( ! $widget_id || $widget_id == $wp_registered_widgets[ $widget ]['id'] ) {
							return $sidebar;
						}
					}
				}
			}
		}
	}
	return false;
}

Related Functions

From tag: Sidebar (widgets)

No comments
    Hello, !     Log In . Register