Skip to content

Add defaults and accepted values for runcommand() options in doc #5953

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

Merged
mrsdizzie merged 7 commits into from
Feb 28, 2025
Merged

Add defaults and accepted values for runcommand() options in doc #5953

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0162aa1
Update runcommand docs
i-am-chitti May 27, 2024
4c0e739
Update php/class-wp-cli.php
mrsdizzie Feb 28, 2025
abe9152
Update php/class-wp-cli.php
mrsdizzie Feb 28, 2025
e32f686
Update php/class-wp-cli.php
mrsdizzie Feb 28, 2025
ab17293
Update php/class-wp-cli.php
mrsdizzie Feb 28, 2025
a8c0432
Update php/class-wp-cli.php
mrsdizzie Feb 28, 2025
57bfc0c
Update php/class-wp-cli.php
mrsdizzie Feb 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion php/class-wp-cli.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1289,7 +1289,15 @@ public static function get_config( $key = null ) {
* @category Execution
*
* @param string $command WP-CLI command to run, including arguments.
* @param array $options Configuration options for command execution.
* @param array $options {
* Configuration options for command execution.
*
* @type bool $launch Launches a new process (true) or reuses the existing process (false). Default: true.
* @type bool $exit_error Halts the script on error. Default: true.
* @type bool|string $return Returns output as an object when set to 'all' (string), return just the 'stdout', 'stderr', or 'return_code' (string) of command, or print directly to stdout/stderr (false). Default: false.
* @type bool|string $parse Parse returned output as 'json' (string); otherwise, output is unchanged (false). Default: false.
* @param array $command_args Contains additional command line arguments for the command. Each element represents a single argument. Default: empty array.
* }
* @return mixed
*/
public static function runcommand( $command, $options = [] ) {
Expand Down
Loading