Docs: Fix stale, incorrect, or missing documentation#78686
Conversation
| @@ -48,6 +52,12 @@ New styles options are integrated into theme.json on a regular basis. Knowing th | |||
| | `spacing.margin.left` | 5.8 | 5.9 | | |||
| | `spacing.margin.bottom` | 5.8 | 5.9 | | |||
| | `spacing.blockGap` | 5.9 | 5.9 | | |||
| | `background.backgroundAttachment` | 6.6 | 6.6 | | |||
| | `background.backgroundImage` | 6.6 | 6.5 | | |||
| | `background.backgroundPosition` | 6.6 | 6.6 | | |||
| | `background.backgroundRepeat` | 6.6 | 6.6 | | |||
| | `background.backgroundSize` | 6.6 | 6.6 | | |||
| | `dimensions.aspectRatio` | 6.6 | 6.6 | | |||
There was a problem hiding this comment.
These require careful review for correctness.
There was a problem hiding this comment.
Maybe @andrewserong or @aaronrobertshaw can help here?
There was a problem hiding this comment.
Nearly right but a couple of discrepancies, from cross referencing with the Theme JSON class: https://github.com/WordPress/wordpress-develop/blob/0561e773e90cacefd8526cabd5a538c975848cc1/src/wp-includes/class-wp-theme-json.php#L405
From a quick skim:
- Background attachment was 6.7
- Background image was 6.4
- Background position was 6.6 (good 👍)
- Background repeat was 6.6 (good 👍)
- Background size was 6.6 (good 👍)
- Dimensions aspect ratio was 6.5
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
…lumns Per review feedback cross-referencing class-wp-theme-json.php VALID_SETTINGS: backgroundImage 6.4, backgroundPosition/Repeat/Size 6.6, aspectRatio 6.5.
|
Size Change: 0 B Total Size: 8.21 MB ℹ️ View Unchanged
|
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
| ``` | ||
|
|
||
| You may notice the use of the [`withSyncEvent()`](#withsyncevent) utility function in this example. This is necessary due to an ongoing effort to handle store actions asynchronously by default, unless they require synchronous event access (which this example does due to the call to `event.preventDefault()`). Otherwise a deprecation warning will be triggered, and in a future release the behavior will change accordingly. | ||
| You may notice the use of the [`withSyncEvent()`](#withsyncevent) utility function in this example. This is necessary due to an ongoing effort to handle store actions asynchronously by default, unless they require synchronous event access (which this example does due to the call to `event.preventDefault()`). Otherwise a deprecation warning will be triggered, and in WordPress 7.0 the behavior will change accordingly. |
There was a problem hiding this comment.
Are we sure this landed in 7.0?
There was a problem hiding this comment.
There's a mention here: https://make.wordpress.org/core/2025/03/24/interactivity-api-best-practices-in-6-8/
I don't see anything specific in the 7.0 release notes: https://make.wordpress.org/core/2026/02/23/changes-to-the-interactivity-api-in-wordpress-7-0/
@luisherranz will you help review this Interactivity API documentation fix for correctness?
There was a problem hiding this comment.
We haven't deprecated anything in WordPress 7.0, but a few days ago I included a new section for deprecations in the roadmap to review them for 7.1.
ccing @felixarntz as he was the one adding withSyncEvent and its deprecations.
There was a problem hiding this comment.
I'll remove this 7.0 change.
ntsekouras
left a comment
There was a problem hiding this comment.
Thanks! I've left a couple of comments(with some pings) to look into, but everything else LGTM.
What?
Update documentation across the project where docs were found to be stale, incorrect, or otherwise lacking.
Use of AI Tools
Claude was used to analyze the state of documentation and make updates and corrections.