Merge pull request #5953 from i-am-chitti/GH-5259/update-runcommand-docs

mrsdizzie · web-flow · commit 90c9a75f1145 · 2025-02-28T10:55:52.000-05:00
Add defaults and accepted values for runcommand() options in doc
diff --git a/php/class-wp-cli.php b/php/class-wp-cli.php
@@ -1291,7 +1291,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 = [] ) {
