Code Editor: Register Ctrl/Cmd + S to trigger file save in Theme/Plugin Editor #10851

westonruter · 2026-02-02T21:04:57Z

Trac ticket: https://core.trac.wordpress.org/ticket/17133

For details, see:

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

Expose the `updateErrorNotice` method on the `wp.codeEditor` instance to allow forcing the display of linting errors. In the Theme and Plugin editors, this method is now called during the submission process. This ensures that errors are visible when using the save shortcuts (`Ctrl+S` or `Cmd+S`) while the editor is focused, preventing a silent failure when the save is blocked by validation errors. Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

…ghlighting (CodeMirror) is disabled Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Updates the Code Editor to use the `inputRead` event instead of `keyup` for triggering autocompletion. `inputRead` is more reliable than `keyup` for triggering autocompletion because it fires only when the document content has actually changed due to user input. 1. **Modifier Keys Don't Trigger It:** `keyup` fires whenever *any* key is released. This includes `Shift`, `Ctrl`, `Cmd`, `Alt`, etc. This was causing a bug where releasing `Cmd` after `Cmd+S` triggered the `keyup` listener. `inputRead` ignores these entirely because pressing `Cmd` doesn't insert text into the editor. 2. **No Race Conditions:** With `keyup`, one has to guess if the keystroke was part of a combo (like `Cmd+S`) by checking modifier states. However, if the user releases the modifier *before* the character key, the `keyup` event for the character key sees `metaKey: false`, looking exactly like a normal typed character. `inputRead` avoids this race condition completely because the save command (Cmd+S) doesn't insert text, so `inputRead` never fires. 3. **Handles Non-Keyboard Input:** `inputRead` also handles cases like dragging and dropping text or using an Input Method Editor (IME), where `keyup` events can be complex. 4. **Simpler Logic:** There is no need to manually filter out navigation keys (Arrows, Home, End) or function keys. `inputRead` only indicates "text was added", which is exactly when we want to consider showing a hint. Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Fixes a `JQMIGRATE: jQuery.fn.submit() event shorthand is deprecated` warning by using the explicit `.trigger()` method to initiate form submission. Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

github-actions · 2026-02-03T05:19:47Z

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

The Plugin and Theme Directories cannot be accessed within Playground.
All changes will be lost when closing a tab with a Playground instance.
All changes will be lost when refreshing the page.
A fresh instance is created each time the link below is clicked.
Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

Update the global keyboard listener for save shortcuts to use the same trigger mechanism as the CodeMirror shortcut handler. Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Improves the robustness of the autocompletion trigger by specifically allowing only `+input` and `*compose` origins. These origins are part of CodeMirror 5's internal system for categorizing document changes: - `+input`: Represents direct character input from keyboard typing. - `*compose`: Represents Input Method Editor (IME) composition, used for languages like Japanese, Chinese, or Korean. By specifically targeting these origins, the editor effectively ignores changes that should not trigger autocompletion, such as `undo`, `redo`, `drag`, or programmatic updates. This also replaces the previous less-specific check for `paste`. Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

westonruter · 2026-02-03T05:41:35Z

Review form Gemini:

Here is the final review of the changes, incorporating the latest robustness and consistency improvements.

Summary of Changes

The PR improves the WordPress Code Editor (used in Theme and Plugin editors) by making autocompletion significantly more robust and fixing issues with save shortcuts.

Key Technical Enhancements:

Autocomplete Reliability: Switched from keyup to inputRead for triggering hints. This ensures that autocompletion only fires when content actually changes due to typing or IME composition (+input and *compose origins), effectively ignoring modifier key releases like the S in Cmd+S.
Global Save Shortcut: Added a global keydown listener to the window in the Theme/Plugin editor. This ensures Ctrl+S and Cmd+S work even when the editor isn't focused (e.g., after dismissing a lint notice).
Forced Error Visibility: Exposed updateErrorNotice on the wp.codeEditor instance. The Theme/Plugin editor now calls this on submit to ensure lint errors are visible if a save is blocked, preventing "silent" save failures.
Modern Standards: Switched from deprecated jQuery .submit() shorthands to .trigger( 'submit' ).

Detailed Review

`src/js/_enqueues/wp/code-editor.js`

Robustness: The origin check '+input' !== change.origin && ! change.origin.startsWith( '*compose' ) is excellent. It targets the exact internal origins CodeMirror uses for typing, filtering out noise from paste, undo, redo, and drag.
Logic: The check for 1 !== change.text.length || 1 !== change.text[0].length correctly limits autocompletion to single-character typing, which is the intended behavior for the integrated linters.
Compatibility: Usage of startsWith is appropriate given the /* eslint-env es2020 */ header.
Documentation: JSDoc correctly updated for configureLinting and CodeEditorInstance.

`src/js/_enqueues/wp/theme-plugin-editor.js`

Consistency: The use of component.form.trigger( 'submit' ) in both the global window listener and the CodeMirror extraKeys handler is a significant improvement for consistency and reliability. It ensures the form's submit event is handled uniformly regardless of how it was triggered.
UX Fix: Forcing the error notice on submit resolves a common point of confusion where users couldn't see why their save was failing while focused in the editor.
Coding Standards: The code adheres to WordPress standards regarding indentation, Yoda conditions, and proper event handling.

Conclusion

The latest iteration addressed all previously identified nit-picks, including the "race condition" on shortcut release and the consistency of the submit trigger. The resulting code is clean, robust, and follows WordPress Core best practices.

Final Approval.

github-actions · 2026-02-03T05:41:55Z

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 props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props desrosj, westonruter, jonsurrell.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

sirreal · 2026-02-03T11:43:15Z

I noticed some strange behavior where lint errors (at least for JavaScript) seem to accumulate. I believe this is also present on trunk, so this is just an observation.

cumulative-errors.mov

sirreal

This seems to work well. I found several quirks in the editor, but they're all pre-existing on trunk.

sirreal · 2026-02-03T11:02:34Z

src/js/_enqueues/wp/code-editor.js

+			 * Note that rules must be sent in the "deprecated" lint.options property
 			 * to prevent linter from complaining about unrecognized options.
 			 * See <https://github.com/codemirror/CodeMirror/pull/4944>.


I don't know exactly what's going on in this comment, but it caught my attention.

codemirror/codemirror5#4944 was merged so this may be out of date?

Not necessary to change anything in this PR.

Good callout. After merging this I intend to do an overall pass on this file and theme-plugin-editor.js to clean up stuff like this. I'm going to fix types and update docs. Once everything is pristine, then this should greatly help with plotting a course for v6.

desrosj and others added 2 commits February 2, 2026 15:53

https://core.trac.wordpress.org/attachment/ticket/17133/17133.diff

a0cfad9

Update whitespace for code style

03f4950

westonruter marked this pull request as draft February 2, 2026 23:54

westonruter and others added 6 commits February 2, 2026 15:59

Remove EOL whitespace

f322df5

Enable save keyboard shortcut when editor is not focused or syntax hi…

18898a3

…ghlighting (CodeMirror) is disabled Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Prevent autocompletion when read-only

b5f6e85

westonruter force-pushed the trac-17133 branch from 4ba5b57 to 0d8c2df Compare February 3, 2026 05:13

This comment was marked as outdated.

Sign in to view

westonruter and others added 2 commits February 2, 2026 21:21

westonruter marked this pull request as ready for review February 3, 2026 05:41

westonruter requested a review from sirreal February 3, 2026 05:55

sirreal approved these changes Feb 3, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Code Editor: Register Ctrl/Cmd + S to trigger file save in Theme/Plugin Editor #10851

Code Editor: Register Ctrl/Cmd + S to trigger file save in Theme/Plugin Editor #10851

westonruter commented Feb 2, 2026 •

edited

Loading

Uh oh!

This comment was marked as outdated.

github-actions bot commented Feb 3, 2026

Uh oh!

westonruter commented Feb 3, 2026

Uh oh!

github-actions bot commented Feb 3, 2026 •

edited

Loading

Uh oh!

sirreal commented Feb 3, 2026

Uh oh!

sirreal left a comment

Uh oh!

sirreal Feb 3, 2026

Uh oh!

westonruter Feb 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Code Editor: Register Ctrl/Cmd + S to trigger file save in Theme/Plugin Editor #10851

Are you sure you want to change the base?

Code Editor: Register Ctrl/Cmd + S to trigger file save in Theme/Plugin Editor #10851

Conversation

westonruter commented Feb 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as outdated.

github-actions bot commented Feb 3, 2026

Test using WordPress Playground

Some things to be aware of

Uh oh!

westonruter commented Feb 3, 2026

Summary of Changes

Detailed Review

src/js/_enqueues/wp/code-editor.js

src/js/_enqueues/wp/theme-plugin-editor.js

Conclusion

Uh oh!

github-actions bot commented Feb 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sirreal commented Feb 3, 2026

Uh oh!

sirreal left a comment

Choose a reason for hiding this comment

Uh oh!

sirreal Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

westonruter Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

westonruter commented Feb 2, 2026 •

edited

Loading

`src/js/_enqueues/wp/code-editor.js`

`src/js/_enqueues/wp/theme-plugin-editor.js`

github-actions bot commented Feb 3, 2026 •

edited

Loading