@wordpress/preferences-persistence

Preferences persistence

Persistence utilities for wordpress/preferences.

Includes a persistence layer that saves data to WordPress user meta via the REST API. If for any reason data cannot be saved to the database, this persistence layer also uses local storage as a fallback.

Installation

Install the module

npm install @wordpress/preferences-persistence --save

This package assumes that your code will run in an ES2015+ environment. If you're using an environment that has limited or no support for such language features and APIs, you should include the polyfill shipped in @wordpress/babel-preset-default in your code.

Usage

Call the create function to create a persistence layer.

const persistenceLayer = create();

Next, configure the preferences package to use this persistence layer:

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

Reference

create

Creates a persistence layer that stores data in WordPress user meta via the REST API.

Parameters

• options Object:
• options.preloadedData ?Object: Any persisted preferences data that should be preloaded. When set, the persistence layer will avoid fetching data from the REST API.
• options.localStorageRestoreKey ?string: The key to use for restoring the localStorage backup, used when the persistence layer calls localStorage.getItem or localStorage.setItem.
• options.requestDebounceMS ?number: Debounce requests to the API so that they only occur at minimum every requestDebounceMS milliseconds, and don't swamp the server. Defaults to 2500ms.

Returns

• Object: A persistence layer for WordPress user meta.

Contributing to this package

This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to npm and used by WordPress as well as other software projects.

To find out more about contributing to this package or Gutenberg as a whole, please read the project's main contributor guide.