Feature: save lock control via actions

[adamsilverstein]

Description

Add a post save locking feature. Plugins can add and remove locks and when any locks are present the publish and update buttons are disabled.

Supersedes #10115
Fixes #7020

How has this been tested?

Load gutenberg and make some edits. In the console, type:
wp.data.dispatch( 'core/editor' ).lockPostSaving( 'mylock' );
Note: the publish or update button becomes disabled.
Remove the post lock with:
wp.data.dispatch( 'core/editor' ).unlockPostSaving( 'mylock' );

• Test adding multiple locks: the button will remain disabled until all locks are removed.

Types of changes

• Add actions for lock and unlock post saving.
• Add an isPostSavingLocked selector
• Check isPostSavingLocked in post publish button

Checklist:

• My code is tested.
• My code follows the WordPress code style.
• My code follows the accessibility standards.
• My code has proper inline documentation.

[aduth]

Do we need to consider the post lock for autosaving?

We should have unit tests for at least selectors and reducer.

You need to run and commit changed files from npm run docs:build.

[adamsilverstein]

Do we need to consider the post lock for autosaving?

I don't think so, these should fire as usual. Autosaves protect the user from lost content.

We should have unit tests for at least selectors and reducer.

I can add these, wanted to make sure approach was acceptable first.

You need to run and commit changed files from npm run docs:build.

Ah, ok will do.

[adamsilverstein]

@aduth I have addressed your feedback and this is ready for review.

[gziolo]

All the changes look great.

We should have unit tests for at least selectors and reducer.

Let's do that ☝️

We also need to start a new document with UI extensibility for the editor and provide some examples on how to use it in action.

[adamsilverstein]

@aduth - I addressed your feedback.

[adamsilverstein]

I'll work on some tests.

[gziolo]

Thanks @adamsilverstein, great to see we have it finally sorted out 🎉

[gziolo]

I will open a follow-up with CHANGELOG update, I missed it.

[chrisvanpatten]

@adamsilverstein We've had a few requests for documentation on this so I'm digging in to try to understand how this was implemented. One question I have is why was this implemented just as a save lock, vs separate publish and save locks? Just curious from a conceptual level. I have read the original ticket and the other related closed PRs, but still not sure I understand.

[jaboi]

@chrisvanpatten Any update on documentation for this? I have a theme that requires a featured image to be horizontal, and the hooks I used to handle the validation and error messaging for this do not work at all with Gutenberg. I think this "save locking" feature is what I'm looking for, but need some kind of documentation to implement. Any feedback would be helpful. Thanks!

[jaboi]

Does anyone have a working example of this save lock control action for a publish/update conditional?

[adamsilverstein]

We've had a few requests for documentation on this so I'm digging in to try to understand how this was implemented. One question I have is why was this implemented just as a save lock, vs separate publish and save locks? Just curious from a conceptual level. I have read the original ticket and the other related closed PRs, but still not sure I understand.

@chrisvanpatten missed this earlier. likely we chose this approach because this is how the buttons were already architected in regards to other conditionals. plugins should be able to control each button (publish vs update) individually still, happy to help with some example code here.

[bryanbartow]

Any update on documentation and/or example(s) for this? Can't seem to find anything here, on the codex, nor stack exchange.

[adamsilverstein]

Any update on documentation and/or example(s) for this? Can't seem to find anything here, on the codex, nor stack exchange.

Happy to add some documentation, where should this go?

[aduth]

Happy to add some documentation, where should this go?

Since this was merged, enhancements were made to the data documentation workflow, so we could include examples for actions (like the ones introduced here) using @example JSDoc tags.

See also:

• Consolidate doc generation and fix next/prev links issue #15421
• Example @example

[adamsilverstein]

so we could include examples for actions (like the ones introduced here) using @example JSDoc tags.

Excellent, thanks for the tip. I'll work on it.