WordPress判断指定外观小工具是否启用的函数is_active_widget

WordPress函数 is_active_widget() 的作用是在小工具初始化后，检测某个外观小工具（如搜索小工具）是否被启用（被添加到侧边栏），如果该小工具被启用了，则返回 true 或小工具所在的侧边栏ID，如果该小工具没有被启用，则返回 false 或者小工具所在的侧边栏ID为空。需要注意的是，测试发现该函数好像只对旧版小工具有效，不支持区块小工具。

函数代码

1

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

参数

$callback – （callable|false）（可选）要检查的小部件回调。默认值：false
$widget_id – （string|false）（可选）小工具 ID。 但需要检查。默认值：false
$id_base – （string|false）（可选）通过扩展 WP_Widget 创建的小部件的基本 ID。默认值：false
$skip_inactive – （布尔）（可选）是否签入“wp_inactive_widgets”。默认值：true

示例

判断分类小工具

1
2
3
4
5
6
7

if ( is_active_widget(false, false, 'categories', true ) ) {
    echo '分类小工具已启用';
}else{
	echo '分类小工具未启用';
}
?>

输入分类小工具所在的侧边栏ID

1

print_r(is_active_widget(false, false, 'categories', true ));

源代码文件：wp-includes/widgets.php

官方文档：https://developer.wordpress.org/reference/functions/is_active_widget/