当前浏览:首页 / WordPress函数 / is_active_widget()

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

判断是否在前端显示给定的小工具

active

is 条件判断more...

widget 小工具


描述

可以使用$callback或$id_base,$id_base是扩展不带可选$widget_id参数的WP_Widget类时的第一个参数,返回第一个边栏的ID,其中找到具有给定回调或$id_base的小工具的第一个实例。使用$widget_id参数,返回边栏的ID,其中包含该callback/$id_base的小工具和该ID。

注意:$widget_id和$id_base对于单个小工具是相同的。为了有效,该函数必须在小工具初始化后,在动作‘init’或更高的时候运行。

更多类似的主题函数信息,请查看主题开发手册中的条件标签文章。


参数

$callback

(callable|false)(可选) 小工具回调以检查。

默认值: false

$widget_id

(string|false)(可选) 小工具ID。可选,但需要检查。

默认值: false

$id_base

(string|false)(可选) 通过扩展WP_Widget创建的小工具的基本ID。

默认值: false

$skip_inactive

(bool)(可选) 是否在'wp_inactive_widgets'中检查。

默认值: true


返回

(string|false) 小工具处于激活状态的边栏ID,如果小工具不处于激活状态,则为false。



源码

查看源码 官方文档


更新日志

版本描述
2.2.0开始引入

使用示例

  • 示例1

    仅当小工具处于活动状态时加载脚本

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