インストール

モジュールをインストールします 

  1. npm install @wordpress/preferences-persistence --save

このパッケージは、あなたのコードが*ES2015+環境で実行されることを前提としています。そのような言語機能やAPIのサポートが限られているか、まったくない環境を使用している場合は、コードに@wordpress/babel-preset-defaultで提供されるポリフィルを含めるべきです。

使用法

  3. ``````bash
  4. const persistenceLayer = create();
  5. `

次に、設定パッケージをこの永続層を使用するように構成します: 

  1. wp.data( 'core/preferences' ).setPersistenceLayer( persistenceLayer );

リファレンス

作成

REST APIを介してWordPressユーザーメタにデータを保存する永続層を作成します。

パラメータ

  • options Object:
  • options.preloadedData ?Object: プリロードすべき永続化された設定データ。設定すると、永続層はREST APIからデータを取得しません。
  • options.localStorageRestoreKey ?string: 永続層がlocalStorage.getItemまたはlocalStorage.setItemを呼び出すときに使用するlocalStorageバックアップの復元キー。
  • options.requestDebounceMS ?number: APIへのリクエストをデバウンスし、最小限でもrequestDebounceMSミリ秒ごとにのみ発生させ、サーバーを圧倒しないようにします。デフォルトは2500msです。

戻り値

  • Object: WordPressユーザーメタ用の永続層です。

このパッケージへの貢献

これはGutenbergプロジェクトの一部である個別のパッケージです。このプロジェクトはモノレポとして整理されています。特定の目的を持つ複数の自己完結型ソフトウェアパッケージで構成されています。このモノレポ内のパッケージはnpmに公開され、WordPressや他のソフトウェアプロジェクトで使用されています。

このパッケージやGutenberg全体への貢献について詳しく知りたい場合は、プロジェクトの主な貢献者ガイドをお読みください。