Overview¶

Tip

Drush 11 and prior required generators to define a drush.services.yml file. This is no longer used with Drush 12+ generators. See docs for injecting dependencies.

Generators jump start your coding by building all the boring boilerplate code for you. After running the generate command, you have a guide for where to insert your custom logic.

Drush's generators reuse classes provided by the excellent Drupal Code Generator project. See its Commands directory for inspiration.

Writing Custom Generators¶

Drupal modules may supply their own Generators, just like they can supply Commands.

Creating a new Drush generator is easy. Follow the steps below.

Run drush generate drush:generator.
Drush will prompt for the machine name of the module that should own the files. The module selected must already exist and be enabled. Use drush generate module to create a new module.
Drush will then report that it created a generator (PHP class and twig file). Edit as needed.
Similar to ExampleGenerator, implement your custom logic in the generate() method.
You may inject dependencies from Drupal or Drush.

Auto-discovered Generators (PSR4)¶

Generators that don't ship inside Drupal modules are called global generators. For example see CustomDrushGenerator. In general, it is better to use modules to carry your generators. If you still prefer using a global generator, please note:

The generator class should be PSR4 auto-loadable.
The generator class namespace, relative to base namespace, should be Drush\Generators. For instance, if a Drush generator provider third party library maps this PSR4 autoload entry:
```
"autoload": {
  "psr-4": {
    "My\\Custom\\Library\\": "src"
  }
}
```
then the Drush global generator class namespace should be My\Custom\Library\Drush\Generators and the class file should be located under the src/Drush/Generators directory.
The filename must have a name like FooGenerator.php. The prefix Foo can be whatever string you want. The file must end in Generator.php.

Site-wide Generators¶

Sitewide generators (as opposed to auto-discovered PSR4) have a namespace that starts with \Drush\Generators, the directory above Generators must be one of: 1. A Folder listed in the --include option. include may be provided via config or via CLI. 1. ../drush, /drush or /sites/all/drush. These paths are relative to Drupal root.

Last update: March 12, 2024

Authors: Claudiu Cristea, Greg Anderson, Moshe Weitzman, Richard B. Porter