Real-time collaboration: Add support for syncing post meta #72332
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Size Change: +208 B (+0.01%) Total Size: 2.07 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in 36afbb3. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/18505483594
|
19 tasks
pkevan
reviewed
Oct 21, 2025
| const shouldSync = Boolean( | ||
| applyFilters( | ||
| 'sync.shouldSyncMeta', | ||
| ! metaKey.startsWith( '_' ), |
There was a problem hiding this comment.
should we also consider meta which can be multiple? i.e. when single is false as per: https://developer.wordpress.org/reference/functions/register_meta/. Unsure how often this is used but given it's a default, it's probably worth considering, particularly if we are syncing the value.
Contributor
Author
There was a problem hiding this comment.
This will work as-is since the values are merged using our existing (recursive) mergeValues. Added a test for this in 6ec79a0
youknowriad
reviewed
Oct 23, 2025
| */ | ||
| const shouldSync = Boolean( | ||
| applyFilters( | ||
| 'sync.shouldSyncMeta', |
Contributor
There was a problem hiding this comment.
Why do we need a filter, why can't we just sync everything? Also, why aren't we syncing private meta (that starts with _). I'm wondering if the security should be at another level, in other words, if a user is able to start a collaborative session for a given "document"/"post" than that user probably already has the right permissions to see the full object.
Contributor
Author
There was a problem hiding this comment.
Why do we need a filter, why can't we just sync everything?
It was initially committed because we implemented CRDT persistence in our plugin and needed a way to exempt it from syncing. If CRDT persistence is merged upstream it can be a single hardcoded exception in the Gutenberg codebase.
Since post meta intersects significantly with plugins, we did wonder if there might be very large post meta values or quirky implementations that need an opt-out filter. I'll remove it until specific examples materialize.
Also, why aren't we syncing private meta (that starts with _).
This is due to an overabundance of caution and an incomplete understanding of "hidden" post meta. The docs seem to indicate that they are used with "classic" meta boxes which might not be compatible with syncing anyway. Again, I'll remove it pending a stronger reason.
if a user is able to start a collaborative session for a given "document"/"post" than that user probably already has the right permissions to see the full object.
Agreed, thanks.
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
36afbb3 to
6814b70
Compare
youknowriad
reviewed
Oct 24, 2025
| // should be synced. | ||
| Object.entries( newValue ?? {} ).forEach( | ||
| ( [ metaKey, metaValue ] ) => { | ||
| if ( disallowedPostMetaKeys.has( metaKey ) ) { |
Contributor
There was a problem hiding this comment.
This is an empty array, we can remove it as well.
Contributor
Author
There was a problem hiding this comment.
When I merge #72373, I will need to add the CRDT post meta to the set.
6ec79a0 to
3e14fbe
Compare
chriszarate
added a commit
that referenced
this pull request
Oct 27, 2025
* Add support for syncing post meta * Sync all meta by default * Add test for non-single meta * Add CRDT persistence meta key to disallowed set
chriszarate
added a commit
that referenced
this pull request
Oct 27, 2025
* Add support for syncing post meta * Sync all meta by default * Add test for non-single meta * Add CRDT persistence meta key to disallowed set
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
Add support for syncing post
metafields in addition to core fields liketitle,blocks, etc.Why?
Post meta fields are central to the editing experience.
How?
In order to be synced, post meta must be registered with the
show_in_restargument set totrue. Otherwise, it is not available to thecore-datastore.Automatically syncing all post meta is probably not desirable behavior. As a default stance, we exclude "hidden" post meta fields (whose meta key begins with an underscore). This gives plugins a code-free path to opting out. We provide a filter that allows plugins to override that default stance.
Testing Instructions
Testing Instructions for Keyboard
No UI changes in this PR.
Screenshots or screencast
post-meta.mov