Command dispatching functions.

  1. 6.x drush/includes/command.inc dispatching
  2. 4.x drush/includes/command.inc dispatching
  3. 5.x drush/includes/command.inc dispatching
  4. 3.x drush/includes/drush.inc dispatching
  5. 7.x drush/includes/command.inc dispatching

These functions handle command dispatching, and can be used to programatically invoke drush commands in different ways.

Functions

Namesort descending Location Description
drush_append_negation_options drush/includes/command.inc
drush_command drush/includes/command.inc Entry point for commands into the drush_invoke() API
drush_dispatch drush/includes/command.inc Given a command record, dispatch it as if it were the original command. Executes in the currently bootstrapped site using the current option contexts. Note that drush_dispatch will not bootstrap any further than the current command has already…
drush_handle_command_output drush/includes/command.inc Convert the structured output array provided from the Drush command into formatted output. Output is only printed for commands that define 'default-format' &/or 'default-pipe-format'; all other commands are expected to do…
drush_invoke drush/includes/command.inc Invokes a Drush API call, including all hooks.
drush_invoke_process drush/includes/command.inc Invoke a command in a new process, targeting the site specified by the provided site alias record.
drush_redispatch_get_options drush/includes/command.inc Get the options that were passed to the current command.
_drush_flatten_options drush/includes/command.inc Return the array keys of $options, plus any 'short-form' representations that may appear in the option's value.
_drush_get_command_options drush/includes/command.inc Return the list of all of the options for the given command record by merging the 'options' and 'sub-options' records.
_drush_invoke_hooks drush/includes/command.inc Invoke Drush API calls, including all hooks.
_drush_verify_cli_arguments drush/includes/command.inc
_drush_verify_cli_options drush/includes/command.inc Fail with an error if the user specified options on the command line that are not documented in the current command record. Also verify that required options are present.

File

drush/includes/command.inc, line 3
The drush command engine.