[Docs] Add overlay parameter to Playground URL options#3457
Open
[Docs] Add overlay parameter to Playground URL options#3457
overlay parameter to Playground URL options#3457Conversation
- 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
| | Option | Valeur par défaut | Description | | ||
| | ------------------ | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | `php` | `8.5` | Charge la version PHP indiquée. Accepte `7.4`, `8.0`, `8.1`, `8.2`, `8.3`, `8.4`, `8.5` ou `latest`. | | ||
| | `wp` | `latest` | Charge la version WordPress indiquée. Accepte les trois dernières versions majeures. Au 1er juin 2024, il s’agit de `6.3`, `6.4` ou `6.5`. Vous pouvez aussi utiliser `latest`, `nightly` ou `beta`. | |
Collaborator
There was a problem hiding this comment.
it looks like the wp versions are a bit outdated based on Since June 1st 2024 right?
mho22
reviewed
Apr 3, 2026
| It works by passing configuration options as query parameters to the Playground URL. For example, to install the pendant theme, you would use the following URL: | ||
| --> | ||
|
|
||
| Elle fonctionne en passant des options de configuration sous forme de paramètres de requête dans l’URL Playground. Par exemple, pour installer le thème pendant, utilisez l’URL suivante : |
Collaborator
There was a problem hiding this comment.
Suggested change
| Elle fonctionne en passant des options de configuration sous forme de paramètres de requête dans l’URL Playground. Par exemple, pour installer le thème pendant, utilisez l’URL suivante : | |
| Elle fonctionne en passant des options de configuration sous forme de paramètres de requête dans l’URL Playground. Par exemple, pour installer le thème "pendant", utilisez l’URL suivante : |
| | `wp` | `latest` | Charge la version WordPress indiquée. Accepte les trois dernières versions majeures. Au 1er juin 2024, il s’agit de `6.3`, `6.4` ou `6.5`. Vous pouvez aussi utiliser `latest`, `nightly` ou `beta`. | | ||
| | `blueprint-url` | | URL du Blueprint utilisé pour configurer cette instance Playground. | | ||
| | `networking` | `yes` | Active ou désactive le réseau dans Playground. Accepte `yes` ou `no`. | | ||
| | `plugin` | | Installe l’extension indiquée. Utilisez le nom tel qu’il apparaît dans l’URL du répertoire d’extensions WordPress. Par exemple, pour `https://wordpress.org/plugins/wp-lazy-loading/`, le nom est `wp-lazy-loading`. Préinstallez plusieurs extensions avec `plugin=coblocks&plugin=wp-lazy-loading&…`. L’installation connecte automatiquement en admin. Plusieurs extensions peuvent être installées en répétant le paramètre `plugin` dans l’URL. | |
Collaborator
There was a problem hiding this comment.
Suggested change
| | `plugin` | | Installe l’extension indiquée. Utilisez le nom tel qu’il apparaît dans l’URL du répertoire d’extensions WordPress. Par exemple, pour `https://wordpress.org/plugins/wp-lazy-loading/`, le nom est `wp-lazy-loading`. Préinstallez plusieurs extensions avec `plugin=coblocks&plugin=wp-lazy-loading&…`. L’installation connecte automatiquement en admin. Plusieurs extensions peuvent être installées en répétant le paramètre `plugin` dans l’URL. | | |
| | `plugin` | | Installe l’extension indiquée. Utilisez le nom tel qu’il apparaît dans l’URL du répertoire d’extensions WordPress. Par exemple, pour `https://wordpress.org/plugins/wp-lazy-loading/`, le nom est `wp-lazy-loading`. Préinstallez plusieurs extensions avec `plugin=coblocks&plugin=wp-lazy-loading&…`. L’installation connecte automatiquement en tant qu'administrateur. Plusieurs extensions peuvent être installées en répétant le paramètre `plugin` dans l’URL. | |
| | `blueprint-url` | | URL du Blueprint utilisé pour configurer cette instance Playground. | | ||
| | `networking` | `yes` | Active ou désactive le réseau dans Playground. Accepte `yes` ou `no`. | | ||
| | `plugin` | | Installe l’extension indiquée. Utilisez le nom tel qu’il apparaît dans l’URL du répertoire d’extensions WordPress. Par exemple, pour `https://wordpress.org/plugins/wp-lazy-loading/`, le nom est `wp-lazy-loading`. Préinstallez plusieurs extensions avec `plugin=coblocks&plugin=wp-lazy-loading&…`. L’installation connecte automatiquement en admin. Plusieurs extensions peuvent être installées en répétant le paramètre `plugin` dans l’URL. | | ||
| | `theme` | | Installe le thème indiqué. Utilisez le nom tel qu’il apparaît dans l’URL du répertoire de thèmes. Par exemple, pour `https://wordpress.org/themes/disco/`, le nom est `disco`. L’installation connecte automatiquement en admin. Plusieurs thèmes peuvent être installés en répétant le paramètre `theme` dans l’URL. | |
Collaborator
There was a problem hiding this comment.
Suggested change
| | `theme` | | Installe le thème indiqué. Utilisez le nom tel qu’il apparaît dans l’URL du répertoire de thèmes. Par exemple, pour `https://wordpress.org/themes/disco/`, le nom est `disco`. L’installation connecte automatiquement en admin. Plusieurs thèmes peuvent être installés en répétant le paramètre `theme` dans l’URL. | | |
| | `theme` | | Installe le thème indiqué. Utilisez le nom tel qu’il apparaît dans l’URL du répertoire de thèmes. Par exemple, pour `https://wordpress.org/themes/disco/`, le nom est `disco`. L’installation connecte automatiquement en tant qu'admininistrateur. Plusieurs thèmes peuvent être installés en répétant le paramètre `theme` dans l’URL. | |
| | `login` | `yes` | Connecte l’utilisateur en tant qu’administrateur. Accepte `yes` ou `no`. | | ||
| | `multisite` | `no` | Active le mode multisite WordPress. Accepte `yes` ou `no`. | | ||
| | `import-site` | | Importe les fichiers du site et la base de données depuis une archive ZIP indiquée par une URL. | | ||
| | `import-wxr` | | Importe le contenu du site depuis un fichier WXR indiqué par une URL. Utilise l’extension WordPress Importer ; l’administrateur par défaut doit être connecté. | |
Collaborator
There was a problem hiding this comment.
Suggested change
| | `import-wxr` | | Importe le contenu du site depuis un fichier WXR indiqué par une URL. Utilise l’extension WordPress Importer ; l’administrateur par défaut doit être connecté. | | |
| | `import-wxr` | | Importe le contenu du site depuis un fichier WXR indiqué par une URL. Utilise l’extension WordPress Importer. l’administrateur par défaut doit être connecté. | |
| | `import-site` | | Importe les fichiers du site et la base de données depuis une archive ZIP indiquée par une URL. | | ||
| | `import-wxr` | | Importe le contenu du site depuis un fichier WXR indiqué par une URL. Utilise l’extension WordPress Importer ; l’administrateur par défaut doit être connecté. | | ||
| | `site-slug` | | Sélectionne le site à charger depuis le stockage du navigateur. Si le site n’existe pas, l’utilisateur est invité à en enregistrer un nouveau avec le slug indiqué. | | ||
| | `language` | `en_US` | Définit la locale de l’instance WordPress. À utiliser avec `networking=yes`, sinon WordPress ne pourra pas télécharger les traductions. | |
Collaborator
There was a problem hiding this comment.
Suggested change
| | `language` | `en_US` | Définit la locale de l’instance WordPress. À utiliser avec `networking=yes`, sinon WordPress ne pourra pas télécharger les traductions. | | |
| | `language` | `en_US` | Définit la localisation de l’instance WordPress. À utiliser avec `networking=yes`, sinon WordPress ne pourra pas télécharger les traductions. | |
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