get_user_setting()
云策文档标注
概述
get_user_setting() 函数用于根据设置名称检索用户界面设置值。它接受设置名称和可选默认值参数，返回保存的设置值或默认值。
关键要点
- 函数参数：$name（必需，字符串，设置名称），$default_value（可选，字符串或false，默认值，默认为false）
- 返回值：混合类型，返回用户设置值或默认值/false（如果不存在）
- 内部实现：通过 get_all_user_settings() 获取所有设置，然后检查指定名称是否存在
- 相关函数：get_all_user_settings() 用于检索所有用户界面设置
- 使用场景：在多个 WordPress 核心类和方法中用于处理用户界面偏好，如 WP_Screen、WP_List_Table 等
- 引入版本：WordPress 2.7.0
代码示例
function get_user_setting( $name, $default_value = false ) {
$all_user_settings = get_all_user_settings();
return isset( $all_user_settings[ $name ] ) ? $all_user_settings[ $name ] : $default_value;
}
原文内容
Retrieves user interface setting value based on setting name.
Parameters
$namestringrequired-
The name of the setting.
$default_valuestring|falseoptional-
Default value to return when $name is not set.
Default:
false
Source
function get_user_setting( $name, $default_value = false ) {
$all_user_settings = get_all_user_settings();
return isset( $all_user_settings[ $name ] ) ? $all_user_settings[ $name ] : $default_value;
}
Changelog
| Version | Description |
|---|---|
| 2.7.0 | Introduced. |