iAPI Docs: Fix typos, code errors, and inaccuracies in the documentation#76636
Open
iAPI Docs: Fix typos, code errors, and inaccuracies in the documentation#76636
Conversation
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…onces Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…on docs Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
… true) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…dates Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The two-hyphen syntax for unique IDs (e.g., data-wp-watch--myId) is deprecated and will stop working in WordPress 7.1. Updated all occurrences to use three hyphens (data-wp-watch---myId) and added deprecation notices. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…ttributes Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
These functions return a deep clone (snapshot), not a frozen/read-only object. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…te/getServerContext Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
… in example Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…ut.md Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…t.md Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…ty API FAQ Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…eferences Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
… start guide Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…ve mindset guide Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…mple Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…array mutation example Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…eset Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…script.md Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…d HTML attributes" This reverts commit 9e795318af2364ccfd7eab1a1bc71a616f9cd8af.
…e examples" This reverts commit 6629f3e92e18b373129dd095fe1c286cb7ac19ca.
…Active reset" This reverts commit 8c4e92d5ed8c1620e81fd0a80f6973ee417c8b23.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…igate() The navigate function should come from the core/interactivity-router store, not from the plugin's own store. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
DAreRodz
requested review from
ajitbohra,
fabiankaegy and
juanmaguitar
as code owners
DAreRodz
added
the
[Feature] Interactivity API
github-actions
bot
added
[Package] Interactivity
|
Flaky tests detected in dacfdd5. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/23250762417
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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?
Fixes multiple documentation issues across the Interactivity API reference guides.
Why?
The Interactivity API docs contained various typos, incorrect code examples, grammar issues, and
inaccuracies that could mislead developers. For example, an unclosed
wp_interactivity_state()call, a
navigate()call referencing the wrong store, invalid JSON, incorrect language tags oncode fences, and several grammar/spelling errors.
How?
Note
For reviewers: the last commit contains format corrections; it can be skipped to check the actual changes in the documentation.
This PR applies fixes across 10 documentation files in
docs/reference-guides/interactivity-api/:references (e.g., use dynamic import from
@wordpress/interactivity-routerfornavigate()),replace
wp_interactivity_statewithwp_interactivity_config/getConfigfor static data likenonces.
sucessfully,extrat,leanier), grammar errors(
allows to set→allows you to set), and subject-verb agreement.getServerState()/getServerContext()read-only behavior,fix Phase 2 ordering to match source, fix CSS deactivation mechanism docs, update deprecated
two-hyphen unique-ID syntax to three hyphens.
javascript→js,php→htmlforHTML-only blocks), standardize
data-wp-interactivequoting to double quotes, normalize~10 KBformatting.
incrementtomultiplywithstate.counter *= state.productto better match the example's
state.productproperty.docs/reference-guides/interactivity-api/) and package markdown files (packages/interactivity/,packages/interactivity-router/) to fix code style inconsistencies.