セレクタ

取得

特定のスコープに対してプリファレンスがアクティブかどうかを示すブール値を返します。

パラメータ

  • state Object: ストアの状態。
  • scope string: 機能のスコープ(例: core/edit-post)。
  • name string: 機能の名前。

返り値

  • *: 機能は有効ですか?

アクション

設定

プリファレンスを値に設定することを示すアクションオブジェクトを返します。

パラメータ

  • scope string: プリファレンスのスコープ(例: core/edit-post)。
  • name string: プリファレンスの名前。
  • value *: 設定する値。

返り値

  • Object: アクションオブジェクト。

デフォルト設定

プリファレンスのデフォルトを設定することを示すアクションオブジェクトを返します。

パラメータ

  • scope string: プリファレンスのスコープ(例: core/edit-post)。
  • defaults Object<string, *>: プリファレンス名と値のキー/バリューマップ。

返り値

  • Object: アクションオブジェクト。

永続層の設定

永続層を設定します。

永続層が設定されると、プリファレンスストアは:

  • get を即座に呼び出し、返された値にストアの状態を更新します。
  • プリファレンスの値が変更されるたびに、すべてのプリファレンスで set を呼び出します。

setPersistenceLayer は、アプリケーションのライフサイクルの開始時に、他のアクションがプリファレンスストアにディスパッチされる前にディスパッチされるべきです。

パラメータ

  • persistenceLayer WPPreferencesPersistenceLayer: 永続層。

返り値

  • Object: アクションオブジェクト。

トグル

プリファレンスをトグルすることを示すアクションオブジェクトを返します。

パラメータ

  • scope string: プリファレンスのスコープ(例: core/edit-post)。
  • name string: プリファレンスの名前。