Changeset 61689 for trunk/src/wp-includes/post.php

Timestamp:

02/19/2026 10:25:06 AM (3 months ago)

Author:

ellatrix

Message:

Real-time collaboration: add new REST endpoints, setting, and registered post meta.

Syncs/merges the PHP changes from the Gutenberg PR ​https://github.com/WordPress/gutenberg/pull/75366.

In Gutenberg, we have added support for real-time collaboration using CRDT documents (via the [Yjs library](​https://yjs.dev/)). This work has suggested the following additions to WordPress:

1. A default "sync provider" based on HTTP polling that allows collaborators to share updates with each other. Previously, we relied on WebRTC connections between collaborators for this purpose, but it proved unreliable under many network conditions.
   • Our solution is designed to work on any WordPress installation.
   • HTTP polling is the transport we identified as most likely to work universally.
   • Given the isolation and lifecycle of PHP processes, updates must be stored centrally in order to be shared among peers. We have chosen to store updates in post meta against a special post type, but alternate storage mechanisms are possible.
   • Collaborative editing can involve syncing multiple CRDT documents. To limit the number of connections consumed by this provider, requests are batched.
   • To prevent unbounded linear growth, updates are periodically compacted.
   • To avoid excessive load on lower-resourced hosts, this provider will benefit from usage limits (e.g., a maximum of three connected collaborators) enforced by the client (Gutenberg).

2. A new registered post meta that allows Gutenberg to persist CRDT documents alongside posts.
   • This provides all collaborators with a "shared starting point" for the collaborative session, which avoids duplicate updates.
   • Content stored in the WordPress database always remains the source of truth. If the content differs from the persisted CRDT document, the CRDT document is updated to match the database.

3. A new Writing setting that allows users to opt-in to real-time collaboration.
   • Enabling real-time collaboration disables post lock functionality and connects users to the sync provider.

4. A behavior change to autosaves is needed. When the the original author is editing a draft post (post_status == 'draft' OR 'auto-draft') and they hold the post lock, the autosave targets the actual post instead of an autosave revision. This puts the post data and the persisted CRDT document out of sync and leads to duplicate updates. When real-time collaboration is enabled, all collaborators must autosave in the same way.

This PR provides a proposed implementation of the changes above. This corresponding Gutenberg PR moves the work from the experimental directory to lib/compat:

​https://github.com/WordPress/gutenberg/pull/75366

Cumulative work to add this functionality can be found using this label:

​https://github.com/WordPress/gutenberg/issues?q=label%3A%22%5BFeature%5D%20Real-time%20Collaboration%22%20is%3Apr

Developed ​https://github.com/WordPress/wordpress-develop/pull/10894.

Props czarate, paulkevan, ellatrix, timothyblynjacobs, westonruter, jorgefilipecosta, mindctrl.
Fixes #64622.

File:

• trunk/src/wp-includes/post.php (modified) (3 diffs)

trunk/src/wp-includes/post.php

@@ -657 +657 @@
         )
     );
+
+    if ( get_option( 'enable_real_time_collaboration' ) ) {
+        register_post_type(
+            'wp_sync_storage',
+            array(
+                'labels'             => array(
+                    'name'          => __( 'Sync Updates' ),
+                    'singular_name' => __( 'Sync Update' ),
+                ),
+                'public'             => false,
+                '_builtin'           => true, /* internal use only. don't use this when registering your own post type. */
+                'hierarchical'       => false,
+                'capabilities'       => array(
+                    'read'                   => 'do_not_allow',
+                    'read_private_posts'     => 'do_not_allow',
+                    'create_posts'           => 'do_not_allow',
+                    'publish_posts'          => 'do_not_allow',
+                    'edit_posts'             => 'do_not_allow',
+                    'edit_others_posts'      => 'do_not_allow',
+                    'edit_published_posts'   => 'do_not_allow',
+                    'delete_posts'           => 'do_not_allow',
+                    'delete_others_posts'    => 'do_not_allow',
+                    'delete_published_posts' => 'do_not_allow',
+                ),
+                'map_meta_cap'       => false,
+                'publicly_queryable' => false,
+                'query_var'          => false,
+                'rewrite'            => false,
+                'show_in_menu'       => false,
+                'show_in_rest'       => false,
+                'show_ui'            => false,
+                'supports'           => array( 'custom-fields' ),
+            )
+        );
+    }
 
     register_post_status(
@@ -8612 +8647 @@
  *
  * @since 6.3.0 Adds `wp_pattern_sync_status` meta field to the wp_block post type so an unsynced option can be added.
+ * @since 7.0.0 Adds `_crdt_document` meta field to post types so that CRDT documents can be persisted.
  *
  * @link https://github.com/WordPress/gutenberg/pull/51144
@@ -8631 +8667 @@
         )
     );
-}
+
+    if ( get_option( 'enable_real_time_collaboration' ) ) {
+        register_meta(
+            'post',
+            '_crdt_document',
+            array(
+                'auth_callback'     => static function ( bool $_allowed, string $_meta_key, int $object_id, int $user_id ): bool {
+                    return user_can( $user_id, 'edit_post', $object_id );
+                },
+                /*
+                 * Revisions must be disabled because we always want to preserve
+                 * the latest persisted CRDT document, even when a revision is restored.
+                 * This ensures that we can continue to apply updates to a shared document
+                 * and peers can simply merge the restored revision like any other incoming
+                 * update.
+                 *
+                 * If we want to persist CRDT documents alongside revisions in the
+                 * future, we should do so in a separate meta key.
+                 */
+                'revisions_enabled' => false,
+                'show_in_rest'      => true,
+                'single'            => true,
+                'type'              => 'string',
+            )
+        );
+    }
+}