Add new preferences persistence API, and save editor preferences in user meta

docs/manifest.json

@@ -1709,6 +1709,12 @@
 		"markdown_source": "../packages/postcss-themes/README.md",
 		"parent": "packages"
 	},
+	{
+		"title": "@wordpress/preferences-persistence",
+		"slug": "packages-preferences-persistence",
+		"markdown_source": "../packages/preferences-persistence/README.md",
+		"parent": "packages"
+	},
 	{
 		"title": "@wordpress/preferences",
 		"slug": "packages-preferences",

lib/compat/wordpress-6.1/persisted-preferences.php

@@ -0,0 +1,106 @@
+<?php
+/**
+ * Server-side requirements for database persisted preferences.
+ *
+ * @package gutenberg
+ */
+
+/**
+ * Register the user meta for persisted preferences.
+ */
+function gutenberg_register_persisted_preferences_meta() {
+	// Create a meta key that incorporates the blog prefix so that each site
+	// on a multisite can have distinct user preferences.
+	global $wpdb;
+	$meta_key = $wpdb->get_blog_prefix() . 'persisted_preferences';
+
+	register_meta(
+		'user',
+		$meta_key,
+		array(
+			'type'         => 'object',
+			'single'       => true,
+			'show_in_rest' => array(
+				'name'    => 'persisted_preferences',
+				'type'    => 'object',
+				'context' => array( 'edit' ),
+				'schema'  => array(
+					'type'                 => 'object',
+					'properties'           => array(
+						'_modified' => array(
+							'description' => __( 'The date and time the preferences were updated.', 'default' ),
+							'type'        => 'string',
+							'format'      => 'date-time',
+							'context'     => array( 'edit' ),
+							'readonly'    => true,
+						),
+					),
+					'additionalProperties' => true,
+				),
+			),
+		)
+	);
+}
+
+add_action( 'init', 'gutenberg_register_persisted_preferences_meta' );
+
+/**
+ * Configures the preferences package to use user meta persistence.
+ */
+function gutenberg_configure_persisted_preferences() {
+	$user_id = get_current_user_id();
+	if ( empty( $user_id ) ) {
+		return;
+	}
+
+	global $wpdb;
+	$meta_key = $wpdb->get_blog_prefix() . 'persisted_preferences';
+
+	$preload_data = get_user_meta( $user_id, $meta_key, true );
+
+	wp_add_inline_script(
+		'wp-preferences',
+		sprintf(
+			'( function() {
+				var serverData = %s;
+				var userId = "%s";
+				var persistenceLayer = wp.preferencesPersistence.__unstableCreatePersistenceLayer( serverData, userId );
+				var preferencesStore = wp.preferences.store;
+				wp.data.dispatch( preferencesStore ).setPersistenceLayer( persistenceLayer );
+			} ) ();',
+			wp_json_encode( $preload_data ),
+			$user_id
+		),
+		'after'
+	);
+
+}
+
+add_action( 'admin_init', 'gutenberg_configure_persisted_preferences' );
+
+/**
+ * Register dependencies for the inline script that configures the persistence layer.
+ *
+ * Note: When porting this to core update the code here:
+ * https://github.com/WordPress/wordpress-develop/blob/d2ab3d183740c3d1252cb921b18005495007e022/src/wp-includes/script-loader.php#L251-L258
+ *
+ * And make the same update to the gutenberg client assets file here:
+ * https://github.com/WordPress/gutenberg/blob/3f3c8df23c70a37b7ac4dddebc82030362133593/lib/client-assets.php#L242-L254
+ *
+ * The update should be adding a new case like this like this:
+ * ```
+ * case 'wp-preferences':
+ *     array_push( $dependencies, 'wp-preferences-persistence' );
+ *     break;
+ * ```
+ *
+ * @param WP_Scripts $scripts An instance of WP_Scripts.
+ */
+function gutenberg_update_preferences_persistence_deps( $scripts ) {
+	$persistence_script = $scripts->query( 'wp-preferences', 'registered' );
+	if ( isset( $persistence_script->deps ) ) {
+		array_push( $persistence_script->deps, 'wp-preferences-persistence' );
+	}
+}
+
+add_action( 'wp_default_scripts', 'gutenberg_update_preferences_persistence_deps', 11 );

lib/load.php

@@ -124,6 +124,7 @@ function gutenberg_is_experiment_enabled( $name ) {
 
 // WordPress 6.1 compat.
 require __DIR__ . '/compat/wordpress-6.1/blocks.php';
+require __DIR__ . '/compat/wordpress-6.1/persisted-preferences.php';
 
 // Experimental features.
 require __DIR__ . '/experimental/block-editor-settings-mobile.php';

package.json

@@ -65,6 +65,7 @@
 		"@wordpress/nux": "file:packages/nux",
 		"@wordpress/plugins": "file:packages/plugins",
 		"@wordpress/preferences": "file:packages/preferences",
+		"@wordpress/preferences-persistence": "file:packages/preferences-persistence",
 		"@wordpress/primitives": "file:packages/primitives",
 		"@wordpress/priority-queue": "file:packages/priority-queue",
 		"@wordpress/react-i18n": "file:packages/react-i18n",