命名空间:core/preferences。

选择器

get

返回一个布尔值,指示某个偏好设置在特定作用域中是否处于激活状态。

参数

  • state StoreState:store 的状态。
  • 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

设置持久化层。

设置持久化层后,preferences store 将:

  • 立即调用 get,并将 store 状态更新为所返回的值。
  • 每当某个偏好设置的值发生变化时,对所有偏好设置调用 set。

setPersistenceLayer 最好在应用程序生命周期开始时进行分发,且应在向 preferences store 分发任何其他动作之前。

参数

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

返回值

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

toggle

返回一个动作对象,用于发出信号,表示应切换某个偏好设置的状态。

参数

  • scope string:偏好设置的作用域(例如 core/edit-post)。
  • name string:偏好设置的名称。