[Documentation] Adding troubleshooting sections for WP-CLI database connections #2333
+49
−2
Conversation
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
|
Lovely, thank you @fellyph! I wonder if we could recognize that type of error and link to the doc page from the error message 🤔 |
bgrgicak
reviewed
Jul 8, 2025
bgrgicak
reviewed
Jul 8, 2025
packages/docs/site/docs/blueprints/09-troubleshoot-and-debug-blueprints.md
Outdated
Show resolved
Hide resolved
jonathanbossenger
suggested changes
Jul 31, 2025
| @@ -11,6 +11,54 @@ When you build Blueprints, you might run into issues. Here are tips and tools to | |||
|
|
|||
| - Require `wp-load`: to run a WordPress PHP function using the `runPHP` step, you’d need to require [wp-load.php](https://github.com/WordPress/WordPress/blob/master/wp-load.php). So, the value of the `code` key should start with `"<?php require_once('wordpress/wp-load.php'); REST_OF_YOUR_CODE"`. | |||
| - Enable `networking`: to access wp.org assets (themes, plugins, blocks, or patterns), or load a stylesheet using [add_editor_style()](https://developer.wordpress.org/reference/functions/add_editor_style/) (say, when [creating a custom block style](https://developer.wordpress.org/news/2023/02/creating-custom-block-styles-in-wordpress-themes)), you’d need to enable the `networking` option: `"features": {"networking": true}`. | |||
| - | |||
There was a problem hiding this comment.
Same comment as above, the way this is worded makes it sound like you can run WP-CLI from non-mounted sites, which I don't think you can. (Happy to be proven wrong). My experience was that I needed to mount /wordpress/ locally to get WP-CLI working, so the documentation should rather be reframed around "How to get WP-CLI working with Playground"
There was a problem hiding this comment.
@jonathanbossenger does it read better now? I saw @fellyph added a relevant commit after this interaction
There was a problem hiding this comment.
Yup, reads better know, thanks folks
adamziel
reviewed
Aug 5, 2025
adamziel
reviewed
Aug 6, 2025
packages/docs/site/docs/blueprints/09-troubleshoot-and-debug-blueprints.md
Outdated
Show resolved
Hide resolved
…lueprints.md Co-authored-by: Adam Zieliński <[email protected]>
adamziel
approved these changes
Sep 3, 2025
adamziel
reviewed
Sep 4, 2025
adamziel
approved these changes
Sep 4, 2025
Co-authored-by: Adam Zieliński <[email protected]>
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.
Motivation for the change, related issues
Issue #2332 identified a scenario where additional steps are required to mount WP-CLI with a mounted playground. This pull request adds a guide for the user to run
WP-CLIcommand successfully with WordPress Playground.Implementation details
Testing Instructions (or ideally a Blueprint)
adding-blueprints-tips.npm run dev:docs