gutenbergdocs/docs/reference-guides/data/data-core-preferences.md

偏好设置

命名空间：core/preferences

选择器

get

返回一个布尔值，指示特定作用域中的偏好设置是否处于启用状态。

参数

• state Object: 存储状态
• scope string: 功能的作用域（例如：core/edit-post）
• name string: 功能名称

返回值

• *: 该功能是否启用？

操作

set

返回用于指示应将偏好设置设定为特定值的操作对象。

参数

• scope string: 偏好设置作用域（例如：core/edit-post）
• name string: 偏好设置名称
• value *: 要设定的值

返回值

• Object: 操作对象

setDefaults

返回用于指示应设定偏好设置默认值的操作对象。

参数

• scope string: 偏好设置作用域（例如：core/edit-post）
• defaults Object<string, *>: 偏好设置名称与值的键值映射表

返回值

• Object: 操作对象

setPersistenceLayer

设置持久化层。

当设置持久化层后，偏好设置存储将：

• 立即调用 get 方法，并将存储状态更新为返回的值
• 当偏好设置值发生变更时，调用 set 方法更新所有偏好设置

理想情况下，应在应用程序生命周期开始时、在向偏好设置存储分发任何其他操作之前分发 setPersistenceLayer。

参数

• persistenceLayer WPPreferencesPersistenceLayer: 持久化层

返回值

• Object: 操作对象

toggle

返回用于指示应切换偏好设置状态的操作对象。

参数

• scope string: 偏好设置作用域（例如：core/edit-post）
• name string: 偏好设置名称