npx skills add ...
npx skills add madsnorgaard/drupal-agent-resources --skill drupal-expert
Drupal 10/11 development expertise. Use when working with Drupal modules, themes, hooks, services, configuration, or migrations. Triggers on mentions of Drupal, Drush, Twig, modules, themes, or Drupal API.
npx skills add madsnorgaard/drupal-agent-resources --skill drupal-expert
You are an expert Drupal developer with deep knowledge of Drupal 10 and 11.
CRITICAL: Before writing ANY custom code, ALWAYS research existing solutions first.
When a developer asks you to implement functionality:
Search on drupal.org/project/project_module:
Evaluate module health by checking:
Ask these questions:
src/t() for all user-facing strings with proper placeholders:
@variable - sanitized text%variable - sanitized and emphasized:variable - URL (sanitized)\Drupal::service() in classes - inject via constructor*.services.ymlContainerInjectionInterface for forms and controllersContainerFactoryPluginInterface for pluginsBoth are valid in modern Drupal. Choose based on context:
Use OOP Hooks when:
Use Event Subscribers when:
#markup with Xss::filterAdmin() or #plain_textTests are not optional for production code.
| Type | Base Class | Use When |
|---|---|---|
| Unit | UnitTestCase | Testing isolated logic, no Drupal dependencies |
| Kernel | KernelTestBase | Testing services, entities, with minimal Drupal |
| Functional | BrowserTestBase | Testing user workflows, page interactions |
| FunctionalJS | WebDriverTestBase | Testing JavaScript/AJAX functionality |
Always use the database abstraction layer:
Always add cache metadata to render arrays:
node:123 - specific nodenode_list - any node listuser:456 - specific userconfig:my_module.settings - configurationBefore writing custom code, use Drush generators to scaffold boilerplate code.
Drush's code generation features follow Drupal best practices and coding standards, reducing errors and accelerating development. Always prefer CLI tools over manual file creation for standard Drupal structures.
CRITICAL: Use CLI commands to create content types and fields instead of manual configuration or PHP code.
Common field types:
string - Plain textstring_long - Long text (textarea)text_long - Formatted texttext_with_summary - Body field with summaryinteger - Whole numbersdecimal - Decimal numbersboolean - Checkboxdatetime - Date/timeemail - Email addresslink - URLimage - Image uploadfile - File uploadentity_reference - Reference to other entitieslist_string - Select listtelephone - Phone numberCommon field widgets:
string_textfield - Single line textstring_textarea - Multi-line texttext_textarea - Formatted text areatext_textarea_with_summary - Body with summarynumber - Number inputcheckbox - Single checkboxoptions_select - Select dropdownoptions_buttons - Radio buttons/checkboxesdatetime_default - Date pickeremail_default - Email inputlink_default - URL inputimage_image - Image uploadfile_generic - File uploadentity_reference_autocomplete - Autocomplete referenceUse Devel Generate for test data instead of manual entry:
1. Always start with generators:
2. Use field:create for all field additions:
3. Export configuration after CLI changes:
4. Document your scaffolding in README:
DON'T manually create:
node.type.*.yml)field.field.*.yml, field.storage.*.yml)core.entity_view_display.*.yml)core.entity_form_display.*.yml)DO use CLI commands:
drush generate for code scaffoldingdrush field:create for fieldsdrush php:eval for content typesdrush config:export to capture changesCRITICAL: Drush generators are interactive by default. Use these techniques to bypass prompts for automation, CI/CD pipelines, and AI-assisted development.
--answers with JSON (Recommended)Pass all answers as a JSON object. This is the most reliable method for complete automation:
--answer FlagsFor simpler generators, use multiple --answer (or -a) flags in order:
Use --dry-run with verbose output to discover all prompts and their expected values:
Use -y or --yes to accept all default values (useful when defaults are acceptable):
Generate a block plugin:
Generate a service:
Generate an event subscriber:
Generate a Drush command:
| Generator | Common Answer Keys |
|---|---|
module | name, machine_name, description, package, dependencies, install_file, libraries, permissions, event_subscriber, block_plugin, controller, settings_form |
controller | module, class, services |
form-simple | module, class, form_id, route, route_path, route_title, route_permission, link |
form-config | module, class, form_id, route, route_path, route_title |
plugin:block | module, plugin_id, admin_label, category, class, services, configurable, access |
service | module, service_name, class, services |
event-subscriber | module, class, event |
--answers JSON - Most reliable for deterministic generation--dry-run first - Preview output before writing files"Missing required answer" error:
JSON parsing errors:
Interactive prompt still appears:
Every user-facing string must go through Drupal's translation API. Never output raw strings.
| Context | Correct |
|---|---|
| PHP (service/controller/form) | $this->t('Hello @name', ['@name' => $name]) |
| PHP (static context) | t('Hello @name', ['@name' => $name]) |
| Plugin attribute | new TranslatableMarkup('My Block') |
| Twig | {% trans %}Hello {{ name }}{% endtrans %} |
@variable — escaped text%variable — escaped and emphasised (wrapped in <em>):variable — URL (escaped)Add use StringTranslationTrait; to classes that need $this->t() without full DI.
|escape){% trans %} for translatable stringsattach_library for CSS/JS, never inline{{ dump(variable) }} for debugging| Feature | Drupal 10 | Drupal 11 |
|---|---|---|
| PHP Version | 8.1+ | 8.3+ |
| Symfony | 6.x | 7.x |
| Hooks | Procedural or OOP | OOP preferred (attributes) |
| Annotations | Supported | Deprecated (use attributes) |
| jQuery | Included | Optional |
Use PHP attributes for plugins (works in D10.2+, required style for D11):
Use OOP hooks (D10.3+):
Register hooks class in services.yml:
Procedural hooks still work but should be in .module file only for backward compatibility.
Drupal Recipes provide reusable configuration packages:
When to use Recipes vs Modules:
Before upgrading D10 → D11:
drupal-check for deprecationsCRITICAL: Always run these checks locally BEFORE committing or pushing code.
CI pipeline failures are embarrassing and waste time. Catch issues locally first.
Common PHPCS errors to watch for:
? type hintCreate .git/hooks/pre-commit:
Make executable: chmod +x .git/hooks/pre-commit
This section describes methodologies for effective AI-assisted Drupal development, based on patterns from the Drupal community's AI tooling.
CRITICAL: Always gather context before generating code. AI produces significantly better output when it understands your project's existing patterns.
Before generating new code, locate similar implementations in your codebase:
Why this matters: When you show existing code patterns to AI, it will:
Before requesting code generation, identify:
Structure your requests with explicit context:
Use hierarchical prompts for complex generation tasks. This approach, documented by Jacob Rockowitz, produces consistently better results.
Based on the Drupal AI CodeGenerator pattern, this methodology breaks complex tasks into deterministic steps:
Determine what type of task is being requested:
| Type | Description | Approach |
|---|---|---|
| Create | New file/component needed | Generate with DCG, then customize |
| Edit | Modify existing code | Read first, then targeted changes |
| Information | Question about code/architecture | Search and explain |
| Composite | Multiple steps needed | Break down, execute sequentially |
Before generating, verify:
Use DCG to scaffold, then customize. This ensures Drupal best practices:
Always generate tests alongside code:
Expect 80% completion from AI-generated code. Plan for refinement cycles.
| Issue | Solution |
|---|---|
| PHPCS errors | Run phpcbf for auto-fix, manual fix for complex issues |
| Missing DI | Add to constructor, update create() method |
| No cache metadata | Add #cache with tags, contexts, max-age |
| Missing access check | Add permission check or access handler |
| No config schema | Create schema file matching config structure |
| Hardcoded strings | Wrap in $this->t() with proper placeholders |
When the AI module is available, leverage drush aigen for rapid prototyping:
Important: Always review AI-generated code. The AI Generation module is experimental and intended for development only.
When generated code doesn't work:
// OOP Hook (Drupal 11+)
#[Hook('form_alter')]
public function formAlter(&$form, FormStateInterface $form_state, $form_id): void {
// ...
}
// Event Subscriber
public static function getSubscribedEvents() {
return [
KernelEvents::REQUEST => ['onRequest', 100],
];
}my_module/
└── tests/
└── src/
├── Unit/ # Fast, isolated tests
├── Kernel/ # Service/entity tests
└── Functional/ # Full browser tests# Run specific test
./vendor/bin/phpunit modules/custom/my_module/tests/src/Unit/MyTest.php
# Run all module tests
./vendor/bin/phpunit modules/custom/my_module
# Run with coverage
./vendor/bin/phpunit --coverage-html coverage modules/custom/my_modulemy_module/
├── my_module.info.yml
├── my_module.module # Hooks only (keep thin)
├── my_module.services.yml # Service definitions
├── my_module.routing.yml # Routes
├── my_module.permissions.yml # Permissions
├── my_module.libraries.yml # CSS/JS libraries
├── config/
│ ├── install/ # Default config
│ ├── optional/ # Optional config (dependencies)
│ └── schema/ # Config schema (REQUIRED for custom config)
├── src/
│ ├── Controller/
│ ├── Form/
│ ├── Plugin/
│ │ ├── Block/
│ │ └── Field/
│ ├── Service/
│ ├── EventSubscriber/
│ └── Hook/ # OOP hooks (Drupal 11+)
├── templates/ # Twig templates
└── tests/
└── src/
├── Unit/
├── Kernel/
└── Functional/services:
my_module.my_service:
class: Drupal\my_module\Service\MyService
arguments: ['@entity_type.manager', '@current_user', '@logger.factory']my_module.page:
path: '/my-page'
defaults:
_controller: '\Drupal\my_module\Controller\MyController::content'
_title: 'My Page'
requirements:
_permission: 'access content'#[Block(
id: "my_block",
admin_label: new TranslatableMarkup("My Block"),
)]
class MyBlock extends BlockBase implements ContainerFactoryPluginInterface {
// Always use ContainerFactoryPluginInterface for DI in plugins
}# config/schema/my_module.schema.yml
my_module.settings:
type: config_object
label: 'My Module settings'
mapping:
enabled:
type: boolean
label: 'Enabled'
limit:
type: integer
label: 'Limit'// CORRECT - parameterized query
$query = $this->database->select('node', 'n');
$query->fields('n', ['nid', 'title']);
$query->condition('n.type', $type);
$query->range(0, 10);
$results = $query->execute();
// NEVER do this - SQL injection risk
$result = $this->database->query("SELECT * FROM node WHERE type = '$type'");$build['content'] = [
'#markup' => $content,
'#cache' => [
'tags' => ['node_list', 'user:' . $uid],
'contexts' => ['user.permissions', 'url.query_args'],
'max-age' => 3600,
],
];# Interactive mode - Drush prompts for all details
drush generate content-entity
# Create via PHP eval (for scripts/automation)
drush php:eval "
\$type = \Drupal\node\Entity\NodeType::create([
'type' => 'article',
'name' => 'Article',
'description' => 'Articles with images and tags',
'new_revision' => TRUE,
'display_submitted' => TRUE,
'preview_mode' => 1,
]);
\$type->save();
echo 'Content type created.';
"# Interactive mode (recommended for first-time use)
drush field:create
# Non-interactive mode with all parameters
drush field:create node article \
--field-name=field_subtitle \
--field-label="Subtitle" \
--field-type=string \
--field-widget=string_textfield \
--is-required=0 \
--cardinality=1
# Create a reference field
drush field:create node article \
--field-name=field_tags \
--field-label="Tags" \
--field-type=entity_reference \
--field-widget=entity_reference_autocomplete \
--cardinality=-1 \
--target-type=taxonomy_term
# Create an image field
drush field:create node article \
--field-name=field_image \
--field-label="Image" \
--field-type=image \
--field-widget=image_image \
--is-required=0 \
--cardinality=1# List all fields on a content type
drush field:info node article
# List available field types
drush field:types
# List available field widgets
drush field:widgets
# List available field formatters
drush field:formatters
# Delete a field
drush field:delete node.article.field_subtitle# Generate a complete module
drush generate module
# Prompts for: module name, description, package, dependencies
# Generate a controller
drush generate controller
# Prompts for: module, class name, route path, services to inject
# Generate a simple form
drush generate form-simple
# Creates form with submit/validation, route, and menu link
# Generate a config form
drush generate form-config
# Creates settings form with automatic config storage
# Generate a block plugin
drush generate plugin:block
# Creates block plugin with dependency injection support
# Generate a service
drush generate service
# Creates service class and services.yml entry
# Generate a hook implementation
drush generate hook
# Creates hook in .module file or OOP hook class (D11)
# Generate an event subscriber
drush generate event-subscriber
# Creates subscriber class and services.yml entry# Generate a custom content entity
drush generate entity:content
# Creates entity class, storage, access control, views integration
# Generate a config entity
drush generate entity:configuration
# Creates config entity with list builder and forms# Generate a plugin (various types)
drush generate plugin:field:formatter
drush generate plugin:field:widget
drush generate plugin:field:type
drush generate plugin:block
drush generate plugin:condition
drush generate plugin:filter
# Generate a Drush command
drush generate drush:command-file
# Generate a test
drush generate test:unit
drush generate test:kernel
drush generate test:browser# Generate 50 nodes
drush devel-generate:content 50 --bundles=article,page --kill
# Generate taxonomy terms
drush devel-generate:terms 100 tags --kill
# Generate users
drush devel-generate:users 20
# Generate media entities
drush devel-generate:media 30 --bundles=image,document# Create module structure first
drush generate module
# Then generate specific components
drush generate controller
drush generate form-config
drush generate service# Never manually create field config files
# Use drush field:create instead
drush field:create node article --field-name=field_subtitle# After creating fields/content types via CLI
drush config:export -y## Regenerating Module Structure
This module was scaffolded with:
- drush generate module
- drush generate controller
- drush field:create node article --field-name=field_custom# When using DDEV
ddev drush generate module
ddev drush field:create node article
# When using Docker Compose
docker compose exec php drush generate module
docker compose exec php drush field:create node article
# When using DDEV with custom commands
ddev exec drush generate controller# Generate a complete module non-interactively
drush generate module --answers='{
"name": "My Custom Module",
"machine_name": "my_custom_module",
"description": "A custom module for specific functionality",
"package": "Custom",
"dependencies": "",
"install_file": "no",
"libraries": "no",
"permissions": "no",
"event_subscriber": "no",
"block_plugin": "no",
"controller": "no",
"settings_form": "no"
}'
# Generate a controller non-interactively
drush generate controller --answers='{
"module": "my_custom_module",
"class": "MyController",
"services": ["entity_type.manager", "current_user"]
}'
# Generate a form non-interactively
drush generate form-simple --answers='{
"module": "my_custom_module",
"class": "ContactForm",
"form_id": "my_custom_module_contact",
"route": "yes",
"route_path": "/contact-us",
"route_title": "Contact Us",
"route_permission": "access content",
"link": "no"
}'# Answers are consumed in order of the prompts
drush generate controller --answer="my_module" --answer="PageController" --answer=""
# Short form
drush gen controller -a my_module -a PageController -a ""# Preview generation and see all prompts
drush generate module -vvv --dry-run
# This shows you exactly what answers are needed
# Then re-run with --answers JSON# Accept all defaults
drush generate module -y
# Combine with some answers to override specific defaults
drush generate module --answer="My Module" -ydrush generate plugin:block --answers='{
"module": "my_custom_module",
"plugin_id": "my_custom_block",
"admin_label": "My Custom Block",
"category": "Custom",
"class": "MyCustomBlock",
"services": ["entity_type.manager"],
"configurable": "no",
"access": "no"
}'drush generate service --answers='{
"module": "my_custom_module",
"service_name": "my_custom_module.helper",
"class": "HelperService",
"services": ["database", "logger.factory"]
}'drush generate event-subscriber --answers='{
"module": "my_custom_module",
"class": "MyEventSubscriber",
"event": "kernel.request"
}'drush generate drush:command-file --answers='{
"module": "my_custom_module",
"class": "MyCommands",
"services": ["entity_type.manager"]
}'