Drupaltools Coding Standards

Drupal Coding Standards

Check and fix PHP code against Drupal coding standards using PHPCS and PHPStan.

When to Use

Use this skill when:

• "Check my module for coding standards"
• "Run PHPCS on my code"
• "Fix coding standards violations"
• "Validate against Drupal standards"

Tools

Check Coding Standards

1. Detect Available Tools

# Check PHPCS
vendor/bin/phpcs --version 2>/dev/null && echo "phpcs_available"

# Check PHPStan
vendor/bin/phpstan --version 2>/dev/null && echo "phpstan_available"

2. Run PHPCS

vendor/bin/phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml

3. Run PHPStan

vendor/bin/phpstan analyse --no-progress --error-format=table

Fix Coding Standards

Auto-fix with PHPCBF

vendor/bin/phpcbf --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml

Common Fixes

Output Format

PHPCS Output

FILE: src/Controller/MyController.php
--------------------------------------------------------------------------------
FOUND 3 ERRORS AFFECTING 3 LINES
--------------------------------------------------------------------------------

  2 | ERROR | [x] Missing file docblock
 15 | ERROR | [ ] Line exceeds 80 characters
 42 | ERROR | [ ] Missing function docblock

FILE: my_module.module
--------------------------------------------------------------------------------
FOUND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------

 23 | WARNING | [ ] Unused variable

PHPStan Output

 ------ -------------------------------------------------------------------
  Line   src/Controller/MyController.php
 ------ -------------------------------------------------------------------
  23     Call to an undefined method Drupal\Core\Entity\EntityInterface::foo().
 ------ -------------------------------------------------------------------

 [ERROR] 1 error

Drupal Coding Standards

Key Rules

Install Tools

composer require --dev drupal/coder phpstan/phpstan

Output Example

✅ CODING STANDARDS CHECK COMPLETE

PHPCS Results: 2 errors, 5 warnings

Errors:
- src/Controller/MyController.php:45 - Line exceeds 80 characters
- src/Plugin/Field/MyField.php:78 - Missing function docblock

Warnings:
- my_module.module:12 - Unused variable $foo
- my_module.module:23 - Line indented with tabs

PHPStan: 0 errors

Auto-fix available: Yes
Run: vendor/bin/phpcbf --standard=Drupal,DrupalPractice

DDEV Commands

When checking coding standards in a Drupal project, first check if tools are installed:

# Check if composer dependencies exist
ddev composer validate 2>/dev/null && echo "vendor_exists" || echo "run composer install first"

Then run tools via DDEV:

# PHPCS via DDEV
ddev exec vendor/bin/phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme

# PHPStan via DDEV
ddev exec vendor/bin/phpstan analyse

# Auto-fix via DDEV
ddev exec vendor/bin/phpcbf --standard=Drupal,DrupalPractice

If vendor doesn't exist, run ddev composer install first.

Frontend Linting

Drupal projects include linting configuration for JS/CSS. Check these files:

Using LSP for PHP

For PHP symbol navigation (classes, methods, references, inheritance), use LSP tools before grep:

1. PHP LSP by Anthropic - php-lsp plugin
2. PHPStorm - SSE at http://localhost:64342/sse
3. cclsp - npx cclsp@latest setup --user
4. Intelephense - VS Code extension

Use LSP for:

• Resolving PHP symbols (classes, interfaces, traits)
• Finding implementations, overrides, inheritance chains
• Locating references across the codebase
• Navigating unfamiliar codebases safely

Resources

• Drupal Coding Standards
• Drupal Practice Standards
• PHPStan Drupal Extension