• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/is active widget

提供: WordPress Codex 日本語版
移動先: 案内検索

説明

この条件分岐タグは、ウィジェットがフロントエンドで表示されているかどうかをチェックします。

この関数が機能するには、ウィジェットが 'init' /en アクションでイニシャライズされた後に実行する必要があります。

使い方

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

パラメータ

$callback
string) (optional) 確認するウィジェットコールバック。
初期値: False
$widget_id
int) (optional) ウィジェット ID。確認のために必要。
初期値: なし
$id_base
string) (optional) WP_Widget を拡張して作られたウィジェットのベース ID。
初期値: なし
$skip_inactive
boolean) (optional) 'wp_inactive_widgets' 内で確認するかどうか。
初期値: True

戻り値

(mixed) 
指定したウィジェットが有効ではない場合 fasle を返し、有効な場合はそのサイドバーの ID 値を返す。コールバックがユニークではない場合、オプションとしてウィジェットの ID を指定することもできる。

用例

ウィジェトが有効な場合のみスクリプトを読み込む

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

更新履歴

2.2.0 以降

ソースファイル

is_active_widget()wp-includes/widgets.php にあります。

関連資料

ウィジェット API: is_active_widget(), the_widget(), register_widget(), unregister_widget() / en, wp_register_widget_control() / en, wp_unregister_widget_control() / en, wp_convert_widget_settings() / en, wp_get_widget_defaults() / en, wp_widget_description() / en


条件分岐タグis_404(), is_admin(), is_admin_bar_showing(), is_archive(), is_attachment(), is_author(), is_category(), is_comments_popup(), is_date(), is_day(), is_feed(), is_front_page(), is_home(), is_local_attachment(), is_main_query, /is_multi_author, is_month(), is_new_day(), is_page(), is_page_template(), is_paged(), is_plugin_active(), is_plugin_active_for_network() /en, is_plugin_inactive() /en, is_plugin_page() /en, is_post_type_archive(), is_preview() /en, is_search(), is_single(), is_singular(), is_sticky(), is_tag(), is_tax(), is_taxonomy_hierarchical(), is_time(), is_trackback(), is_year(), in_category(), in_the_loop(), is_active_sidebar(), is_active_widget(), is_blog_installed() /en, is_rtl(), is_dynamic_sidebar(), is_user_logged_in(), has_excerpt(), has_post_thumbnail(), has_tag(), pings_open(), email_exists(), post_type_exists(), taxonomy_exists(), term_exists(), username_exists() /en, wp_attachment_is_image(), wp_script_is()



関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function Reference/is_active_widget最新版との差分