[Docs] Add overlay parameter to Playground URL options#3457
Merged
Conversation
- Introduced a new `overlay` parameter that opens a UI overlay on page load, currently supporting `blueprints` to directly access the Blueprint Gallery. - The parameter is removed from the URL once the overlay is closed, enhancing user experience by streamlining access to features.
fellyph
requested review from
a team,
JanJakes,
bgrgicak,
brandonpayton and
Copilot
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation for the Playground Query API to describe a new overlay URL parameter that opens specific UI overlays on initial load.
Changes:
- Documented new
overlayquery parameter - Added example usage (
?overlay=blueprints) - Clarified that the parameter is removed from the URL when the overlay closes
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Enhanced the description of the Query API page to clarify its purpose in configuring a WordPress Playground instance via URL parameters. - Improved formatting and consistency in the documentation by adjusting comment styles and correcting minor grammatical errors in the Portuguese text. - Added a detailed explanation of how the API works and provided an example URL for users to test the functionality.
- Introduced a new page detailing the Query API of WordPress Playground, explaining how to configure an instance via URL parameters. - Included examples of usage, available options, and their descriptions in Spanish to enhance accessibility for Spanish-speaking users.
mho22
approved these changes
Apr 3, 2026
...site/i18n/fr/docusaurus-plugin-content-docs/current/developers/06-apis/query-api/01-index.md
Show resolved
Hide resolved
mho22
reviewed
Apr 3, 2026
...site/i18n/fr/docusaurus-plugin-content-docs/current/developers/06-apis/query-api/01-index.md
Outdated
Show resolved
Hide resolved
...site/i18n/fr/docusaurus-plugin-content-docs/current/developers/06-apis/query-api/01-index.md
Outdated
Show resolved
Hide resolved
...site/i18n/fr/docusaurus-plugin-content-docs/current/developers/06-apis/query-api/01-index.md
Outdated
Show resolved
Hide resolved
...site/i18n/fr/docusaurus-plugin-content-docs/current/developers/06-apis/query-api/01-index.md
Outdated
Show resolved
Hide resolved
...site/i18n/fr/docusaurus-plugin-content-docs/current/developers/06-apis/query-api/01-index.md
Outdated
Show resolved
Hide resolved
JanJakes
approved these changes
Apr 9, 2026
…ent/developers/06-apis/query-api/01-index.md Co-authored-by: Yannick Decat <17177411+mho22@users.noreply.github.com>
…ent/developers/06-apis/query-api/01-index.md Co-authored-by: Yannick Decat <17177411+mho22@users.noreply.github.com>
…ent/developers/06-apis/query-api/01-index.md Co-authored-by: Yannick Decat <17177411+mho22@users.noreply.github.com>
…ent/developers/06-apis/query-api/01-index.md Co-authored-by: Yannick Decat <17177411+mho22@users.noreply.github.com>
…ent/developers/06-apis/query-api/01-index.md Co-authored-by: Yannick Decat <17177411+mho22@users.noreply.github.com>
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
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.
This pull request adds new documentation for a UI overlay feature in the Playground's query API. The main change is an update to the documentation to describe the new
overlayURL parameter, which allows users to open specific overlays (like the Blueprint Gallery) automatically when the Playground loads.New feature documentation:
overlayparameter, which lets users open a UI overlay (such as the Blueprint Gallery) on page load by specifying?overlay=blueprintsin the URL. The overlay parameter is removed from the URL when the overlay is closed.introduced on PR #3220