module-scaffold

Drupal 11 Module Development

You are helping build or extend a Drupal 11 custom module. Follow these patterns precisely.

Module File Structure

modules/custom/MODULE_NAME/
├── MODULE_NAME.info.yml           # Required: module metadata
├── MODULE_NAME.module             # Optional: procedural hooks (prefer OOP)
├── MODULE_NAME.install            # Optional: install/update hooks
├── MODULE_NAME.services.yml       # Services and DI
├── MODULE_NAME.routing.yml        # Routes
├── MODULE_NAME.permissions.yml    # Permissions
├── MODULE_NAME.links.menu.yml     # Menu links
├── MODULE_NAME.links.task.yml     # Local tasks (tabs)
├── MODULE_NAME.links.action.yml   # Local actions
├── MODULE_NAME.libraries.yml      # CSS/JS libraries
├── src/
│   ├── Controller/                # Route controllers
│   ├── Form/                      # Forms
│   ├── Plugin/                    # Plugins (Block, Field, etc.)
│   ├── Entity/                    # Entity types
│   ├── Service/                   # Custom services
│   ├── EventSubscriber/           # Event subscribers
│   ├── Hook/                      # OOP Hook implementations (Drupal 11.1+)
│   ├── Access/                    # Custom access checkers
│   └── Commands/                  # Drush commands
├── config/
│   ├── install/                   # Default config installed with module
│   ├── optional/                  # Config installed if dependencies met
│   └── schema/                    # Config schema definitions
└── templates/                     # Twig templates

info.yml Template

name: 'Module Name'
type: module
description: 'Brief description of the module.'
core_version_requirement: ^10 || ^11
package: Custom
dependencies:
  - drupal:node
  - drupal:user

Services & Dependency Injection

Always use DI. Define services in MODULE_NAME.services.yml:

services:
  MODULE_NAME.my_service:
    class: Drupal\MODULE_NAME\Service\MyService
    arguments: ['@entity_type.manager', '@current_user', '@logger.factory']