函数描述
更新用户选项函数可以在单站点或多站点网络中使用。
用户选项就像用户元数据,除了他们在多站点网络中使用时支持指定某个站点。如果 $global 参数设置为 false, 也就是默认值,WordPress将添加数据表前缀到选项名称前。
使用方法
<?php update_user_option( $user_id, $option_name, $newvalue, $global ) ?>
函数参数
参数 | 数据类型 | 是否必需 | 描述 | 默认值 |
---|---|---|---|---|
$user_id | 整数 | 是 | 用户ID | 无 |
$option_name | 字符串 | 是 | 选项名称 | 无 |
$newvalue | 任意值 | 是 | 选项值 | 无 |
$global | 布尔值 | 否 | 多站点网络中选项名称是否为当前站点的 | false |
返回值
布尔值,是否更新成功
使用示例
在网站前端隐藏管理工具条:
update_user_option( $user_id, 'show_admin_bar_front', false );
多站点网络安装后, $global 参数可以用来设置整个网络的用户选项,而不仅仅是当前站点的。
update_user_option( $user_id, 'show_admin_bar_front', false, true );