function sync_enable_drush_help_alter

8.0.x sync_enable.drush.inc sync_enable_drush_help_alter(&$command)
6.x sync_enable.drush.inc sync_enable_drush_help_alter(&$command)
7.x sync_enable.drush.inc sync_enable_drush_help_alter(&$command)
5.x sync_enable.drush.inc sync_enable_drush_help_alter(&$command)
master sync_enable.drush.inc sync_enable_drush_help_alter(&$command)

Implements hook_drush_help_alter().

When a hook extends a command with additional options, it must implement help alter and declare the option(s). Doing so will add the option to the help text for the modified command, and will also allow the new option to be specified on the command line. Without this, Drush will fail with an error when a user attempts to use the option.

File

examples/sync_enable.drush.inc, line 72
Example "Sync enable" sql-sync command alter.

Code

function sync_enable_drush_help_alter(&$command) {
  if ($command['command'] == 'sql-sync') {
    $command['options']['enable'] = "Enable the specified modules in the target database after the sync operation has completed.";
    $command['options']['disable'] = "Disable the specified modules in the target database after the sync operation has completed.";
    $command['options']['permission'] = "Add or remove permissions from a role in the target database after the sync operation has completed. The value of this option must be an array, so it may only be specified in a site alias record or drush configuration file.  See `drush topic docs-example-sync-extension`.";
  }
}