A command line interface for WordPress

Docs » Internal API » Execution


Run a WP-CLI command.


WP_CLI::runcommand( $command, $options = array() )
$command (string) WP-CLI command to run, including arguments.
$options (array) Configuration options for command execution.
@return (mixed)


Launch a new child process, or run the command in the current process. Optionally: * Prevent halting script execution on error. * Capture and return STDOUT, or full details about command execution. * Parse JSON output if the command rendered it.

$options = array(
  'return'     => true,  // Return 'STDOUT'; use 'all' for full object.
  'parse'      => 'json' // Parse captured STDOUT to JSON array.
  'launch'     => false, // Reuse the current process.
  'exit_error' => true,  // Halt script execution on error.
$plugins = WP_CLI::runcommand( 'plugin list --format=json', $options );

Internal API documentation is generated from the WP-CLI codebase on every release. To suggest improvements, please submit a pull request.