Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation: skip-plugins, skip-themes and mu-plugins #5838

Closed
kkmuffme opened this issue Sep 12, 2023 · 2 comments · Fixed by wp-cli/handbook#501
Closed

Documentation: skip-plugins, skip-themes and mu-plugins #5838

kkmuffme opened this issue Sep 12, 2023 · 2 comments · Fixed by wp-cli/handbook#501
Labels
contributor-day scope:documentation scope:framework
Milestone
2.11.0

Comments

@kkmuffme
Copy link

Could the docs for "wp db reset" be updated to clarify that/if:

  1. if the command will not load any themes/plugins (= "--skip-plugins --skip-themes" are the default?)

  2. if the command will not load any mu-plugins?
    If it does load mu-plugins, there should be a way to stop that from happening. As otherwise (malicious) mu-plugins could stop the DB reset by just calling exit; and abort the process.
@danielbachhuber danielbachhuber transferred this issue from wp-cli/db-command Sep 18, 2023
@danielbachhuber
Copy link
Member

Thanks for the suggestion, @kkmuffme

I think we could do even better: for every command with @when before_wp_load, include some explanation of when the command executes.

I moved this to wp-cli/wp-cli because doing so would be a general framework change.

mrsdizzie added a commit to mrsdizzie/wp-cli that referenced this issue Mar 20, 2024
@mrsdizzie
Include any non default hook information in CompositeCommand
c45c422 
This would be a first step towards addressing wp-cli#5838 and including
details on when a specific command is run in the handbook documentation.

I've added the output to the help command as well so there will be
parody between that and the handbook.
@mrsdizzie mrsdizzie mentioned this issue Mar 20, 2024
Merged
mrsdizzie added a commit to mrsdizzie/handbook that referenced this issue Apr 27, 2024
@mrsdizzie
Include hook details in documentation
f740e25 
When a command specifies a non-default hook, include those details in
handbook documentation for the command.

Related: wp-cli/wp-cli#5921

Fixes: wp-cli/wp-cli#5838
@mrsdizzie mrsdizzie mentioned this issue Apr 27, 2024
Merged
@danielbachhuber danielbachhuber added this to the 2.11.0 milestone Apr 29, 2024
@danielbachhuber
Copy link
Member

@mrsdizzie Could you apply the equivalent of wp-cli/handbook#501 to wp scaffold package-readme too? https://github.com/wp-cli/scaffold-package-command

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
contributor-day scope:documentation scope:framework
Projects
None yet
Milestone
2.11.0
Development

Successfully merging a pull request may close this issue.

Include hook details in documentation mrsdizzie/handbook
2 participants
@danielbachhuber @kkmuffme