title: "偏好设置" post_status: publish comment_status: open taxonomy: category: - gutenberg-docs post_tag: - Data - Reference Guides - Repos

偏好设置

命名空间：core/preferences。

选择器

get

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

参数

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

返回值

• *: 该功能是否启用？

操作

set

返回一个操作对象，用于发出信号，表示应将偏好设置为某个值。

参数

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

返回值

• SetAction: 操作对象。

setDefaults

返回一个操作对象，用于发出信号，表示应设置偏好默认值。

参数

• scope string: 偏好作用域（例如 core/edit-post）。
• defaults ScopedDefaults: 偏好名称到值的键/值映射。

返回值

• SetDefaultsAction: 操作对象。

setPersistenceLayer

设置持久化层。

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

• 立即调用 get 并将存储状态更新为返回的值。
• 每当偏好值发生变化时，调用 set 并传入所有偏好。

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

参数

• persistenceLayer WPPreferencesPersistenceLayer< D >: 持久化层。

返回值

• Promise< SetPersistenceLayerAction< D > >: 操作对象。

toggle

返回一个操作对象，用于发出信号，表示应切换某个偏好。

参数

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