function hook_drush_help_alter

8.0.x drush.api.php hook_drush_help_alter(&$command)
6.x drush.api.php hook_drush_help_alter(&$command)
7.x drush.api.php hook_drush_help_alter(&$command)
4.x drush.api.php hook_drush_help_alter(&$command)
5.x drush.api.php hook_drush_help_alter(&$command)
master drush.api.php hook_drush_help_alter(&$command)

Add help components to a command

1 function implements hook_drush_help_alter()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

topic_drush_help_alter in commands/core/topic.drush.inc
Implement hook_drush_help_alter(). Show 'Topics' section on help detail.

File

docs/drush.api.php, line 246
Documentation of the Drush API.

Code

function hook_drush_help_alter(&$command) {
  if ($command['command'] == 'sql-sync') {
    $command['options']['myoption'] = "Description of modification of sql-sync done by hook";
    $command['sub-options']['sanitize']['my-sanitize-option'] = "Description of sanitization option added by hook (grouped with --sanitize option)";
  }
}