Core Hooks

All commandfiles may implement methods that are called by Drush at various times in the request cycle. To implement one, add a @hook validate (for example) to the top of your method.

Custom Hooks

Drush commands can define custom events that other command files can hook. You can find examples in CacheCommands and SanitizeCommands

First, the command must implement CustomEventAwareInterface and use CustomEventAwareTrait, as described in the dependency injection documentation.

Then, the command may ask the provided hook manager to return a list of handlers with a certain annotation. In the example below, the my-event label is used:

     * This command uses a custom event 'my-event' to collect data.  Note that
     * the event handlers will not be found unless the hook manager is
     * injected into this command handler object via `setHookManager()`
     * (defined in CustomEventAwareTrait).
     * @command example:command
    public function exampleCommand()
        $myEventHandlers = $this->getCustomEventHandlers('my-event');
        $result = [];
        foreach ($myEventHandlers as $handler) {
            $result[] = $handler();
        return implode(',', $result);

Other command handlers may provide implementations by implementing @hook on-event my-event.

     * @hook on-event my-event
    public function hookOne()
        return 'one';