WordPress.org

Languages: English • 日本語 (Add your language)

Description

This Conditional Tag checks whether widget is displayed on the front-end.

To be effective this function has to run after widgets have initialized, at action 'init' or later.

Usage

 <?php is_active_widget( $callback, $widget_id, $id_base, $skip_inactive ); ?> 

Parameters

$callback

(string) (optional) Widget callback to check.

Default: False

$widget_id

(int) (optional) Widget ID. Needed for checking.

Default: None

$id_base

(string) (optional) Base ID of a widget created by extending WP_Widget.

Default: None

$skip_inactive

(boolean) (optional) Whether to check in 'wp_inactive_widgets'.

Default: True

Return Values

(mixed) 

Returns false if the specified widget is not active, or the id of the sidebar in which the widget is active. If the callback is non-unique you can optionally specify the ID of the widget.

Examples

Only load a script when the widget is active

<?php
if ( is_active_widget( false, false, $this->id_base, true ) ) {
	wp_enqueue_script( 'jquery' );
}
?>

Change Log

Since: 2.2.0

Source File

is_active_widget() is located in wp-includes/widgets.php.

Related

Widgets: is_active_widget(), the_widget(), register_widget(), unregister_widget(), wp_register_widget_control(), wp_unregister_widget_control(), wp_convert_widget_settings(), wp_get_widget_defaults(), wp_widget_description()

• Article: Introduction to WordPress conditional functions
• Function: comments_open()
• Function: is_404()
• Function: is_admin()
• Function: is_admin_bar_showing()
• Function: is_archive()
• Function: is_attachment()
• Function: is_author()
• Function: is_category()
• Function: is_comments_popup()
• Function: is_date()
• Function: is_day()
• Function: is_feed()
• Function: is_front_page()
• Function: is_home()
• Function: is_local_attachment()
• Function: is_main_query
• Function: is_multi_author
• Function: is_month()
• Function: is_new_day()
• Function: is_page()
• Function: is_page_template()
• Function: is_paged()
• Function: is_plugin_active()
• Function: is_plugin_active_for_network()
• Function: is_plugin_inactive()
• Function: is_plugin_page()
• Function: is_post_type_archive()
• Function: is_preview()
• Function: is_search()
• Function: is_single()
• Function: is_singular()
• Function: is_sticky()
• Function: is_tag()
• Function: is_tax()
• Function: is_taxonomy_hierarchical()
• Function: is_time()
• Function: is_trackback()
• Function: is_year()
• Function: in_category()
• Function: in_the_loop()
• Function: is_active_sidebar()
• Function: is_active_widget()
• Function: is_blog_installed()
• Function: is_rtl()
• Function: is_dynamic_sidebar()
• Function: is_user_logged_in()
• Function: has_excerpt()
• Function: has_post_thumbnail()
• Function: has_tag()
• Function: pings_open()
• Function: email_exists()
• Function: post_type_exists()
• Function: taxonomy_exists()
• Function: term_exists()
• Function: username_exists()
• Function: wp_attachment_is_image()
• Function: wp_script_is()