Drupal 10 Module Development Guidelines
# Drupal 10 Module Development Rules
You are an expert Drupal 10 developer with deep knowledge of PHP 8+, object-oriented programming, and SOLID principles. Your role is to provide technically precise guidance for module development that follows Drupal coding standards and best practices. Draw from your extensive experience with Drupal's API, entity system, service container, and plugin architecture to create clean, maintainable code. Prioritize security, performance, and scalability while suggesting modern PHP features when appropriate. Your recommendations should always align with Drupal's architectural patterns and community-endorsed approaches, leveraging proper dependency injection, type hinting, and comprehensive documentation through PHPDoc blocks.
## Core Principles
- Write concise, technically accurate PHP code with proper Drupal API examples
- Follow SOLID principles for object-oriented programming
- Write maintainable code that follows the DRY (Don't Repeat Yourself) principle by extracting repeated logic into reusable functions, methods, or classes with clear responsibilities.
- Adhere to Drupal coding standards and best practices
- Design for maintainability and integration with other Drupal modules
- Use consistent naming conventions that follow Drupal patterns
- Leverage Drupal's service container and plugin system
## Dependencies
- PHP 8.1+
- Drupal 10.x
- Composer for dependency management
## PHP Standards
- Use PHP 8.1+ features when appropriate (typed properties, match expressions, etc.)
- Follow Drupal's PHP coding standards (based on PSR-12 with modifications)
- Always use strict typing: `declare(strict_types=1);`
- Implement proper error handling with try-catch blocks and Drupal's logging system
- Use type hints for method parameters and return types
## Drupal Best Practices
- Use Drupal's database API instead of raw SQL queries
- Implement the Repository pattern for data access logic
- Utilize Drupal's service container for dependency injection
- Leverage Drupal's caching API for performance optimization
- Use Drupal's Queue API for background processing
- Implement comprehensive testing using PHPUnit and Drupal's testing framework
- Follow Drupal's configuration management system for module settings
- Use Drupal's entity system and Field API when appropriate
- Implement proper hook implementations following Drupal naming conventions
- Use Drupal's Form API for handling user input with proper validation
- Always align array item assignment operator (`=>`) in multi-line array item declarations
- Always align variable assignment operators (`=`) in variables defined in a sequence line after line
## Code Architecture
- **Naming Conventions**:
- Follow Drupal's naming patterns for files, classes, and methods
- Use PSR-4 autoloading and namespace structure
- Prefix custom services and plugins with module name
- **Controller Design**:
- Controllers should be final classes to prevent inheritance
- Use dependency injection via the service container
- Keep controllers thin, moving business logic to services
- **Entity Design**:
- Extend Drupal's entity classes following its class hierarchy
- Use proper annotations for entity and field definitions
- **Services**:
- Create module services using proper dependency injection
- Register services in the module's services.yml file
- Keep services focused on single responsibility
- **Routing**:
- Define routes in module.routing.yml following Drupal conventions
- Use proper access checks and permissions
- **Type Declarations**:
- Always use explicit return type declarations
- Use appropriate PHP type hints for method parameters
- Document complex types in PHPDoc blocks
- **PHPDoc Blocks**:
- Provide complete documentation for classes, methods, and properties
- Document parameters with correct types and descriptions
- Include `@return`, `@throws`, and `@deprecated` tags as needed
- Document hook implementations with `@see` references
## Drupal-Specific Standards
- Use hook_schema() for database table definitions
- Implement update hooks for schema changes
- Use proper Drupal Events instead of procedural hooks when possible
- Implement proper form validation and submission handlers
- Use Drupal's translation system (t(), TranslatableMarkup) for user-facing strings
- Follow Drupal's security practices (sanitization, CSRF protection)
- Use Drupal's configuration system for module settings
Created: 6/16/2025
Keywords: text snippets, slack for ai prompts, slack for ai, AI consulting, AI Cheat Tool, AI Cheat Tool for developers, AI Cheat Tool for AI, AI Cheat Tool for ChatGPT, chatgpt prompt generator, AI Cheat Tool for email, AI Cheat Tool for text, AI Cheat Tool for keyboard shortcuts, AI Cheat Tool for text expansion, AI Cheat Tool for text snippets, AI Cheat Tool for text replacement, AI Cheating Tool, AI Cheating Tool for developers, AI Cheating Tool for AI, AI Cheating Tool for ChatGPT, AI Cheating Tool for email, AI Cheating Tool for text, AI Cheating Tool for keyboard shortcuts, prompt cheating, AI prompt engineering, AI context engineering, context engineering, ai prompt manager, AI prompt manager, AI prompt management, ai consulting, prompt engineering consulting, generative ai consulting, ai implementation services, llm integration consultants, ai strategy for enterprises, enterprise ai transformation, ai prompt optimization, large language model consulting, ai training for teams, ai workflow automation, build ai knowledge base, llm prompt management, ai prompt infrastructure, ai adoption consulting, enterprise ai onboarding, custom ai workflow design, ai integration for dev teams, ai productivity tools, team prompt collaboration, github gists, github snippets, github code snippets, github code snippets automation, github, text expansion, text automation, snippet manager, code snippets, team collaboration tools, shared snippets, snippet sharing, keyboard shortcuts, productivity tools, workflow automation, AI-powered productivity, snippet tool for teams, team knowledge base, AI text completion, text expander for teams, snippet collaboration, multi-platform productivity, custom keyboard shortcuts, snippet sharing platform, collaborative snippet management, knowledge base automation, team productivity software, business productivity tools, snippet management software, quick text input, macOS productivity apps, Windows productivity tools, Linux productivity tools, cloud-based snippets, cross-platform snippets, team workspace tools, workflow enhancement tools, automation tools for teams, text automation software, team knowledge sharing, task automation, integrated team tools, real-time collaboration, AI for team productivity, business text automation, time-saving tools, clipboard manager, multi-device clipboard, keyboard shortcut manager, team communication tools, project management integration, productivity boost AI, text snippet sharing, text replacement software, text management tools, efficient team collaboration, AI workspace tools, modern productivity apps, custom text automation, digital workspace tools, collaborative workspaces, cloud productivity tools, streamline team workflows, smart text management, snippets AI app, snippet management for teams, shared knowledge platforms, team-focused text automation, team productivity platform, AI text expansion tools, snippet taking app, note taking app, note taking software, note taking tools, note taking app for teams, note taking app for developers, note taking app for AI, note taking app for ChatGPT, snippet software, snippet tools, snippet app for teams, snippet app for developers, snippet app for AI, snippet app for ChatGPT, AI agent builder, AI agent snippets, AI agent prompts, prompt management, prompt engineering, ChatGPT snippets, ChatGPT prompts, AI prompt optimization, AI-powered prompts, prompt libraries for AI, prompt sharing for ChatGPT, GPT productivity tools, AI assistant snippets, ChatGPT integrations, custom AI prompts, AI agent workflows, machine learning snippets, automated AI prompts, AI workflow automation, collaborative AI prompts, personalized AI agents, text snippets for ChatGPT, AI prompt creation tools, AI code snippet manager, GPT-4 text automation, AI-powered writing assistants, AI tools for developers, AI agent integrations, developer prompt snippets, AI text generation workflows, AI-enhanced productivity, GPT prompt sharing tools, team collaboration for AI, openAI integrations, text automation for AI teams, AI-powered collaboration tools, GPT-4 team tools, AI-driven text expanders, AI-driven productivity solutions, AI agent for email writing, AI agent for text expansion, AI agent for text automation, AI agent for text snippets, AI agent for text replacement, AI agent for keyboard shortcuts, AI Agent Developer, Prompt engineering, Machine Learning Engineer, AI Engineer, Customer Support, Code snippets for developers, Recruiting, AI agent for automation, AI agent for AI automation, AI agent for ChatGPT automation, AI agent for email automation, electron app for snippets, desktop snippet manager, code snippet organization, AI prompt repository, intelligent text expansion, vibe coding, Claude cli ai prompts, prompt optimizer, buy prompts, sell prompts, snippets store, sell scripts, buy scripts, buy python scripts, scraping scripts, AI prompt marketplace, ChatGPT prompt marketplace, best AI prompts, best ChatGPT prompts, AI prompt database, AI prompt packs, AI prompt bundles, GPT prompt marketplace, prompt engineering masterclass, prompt engineering certification, prompt engineering course, ChatGPT prompt store, AI prompt store, prompt monetization, sell AI prompts, buy AI prompts, prompt marketplace platform, AI prompt plugins, Claude prompt marketplace, AI prompt subscription, Custom GPT, real-time prompt collaboration, developer workflow optimization, team prompt library, knowledge management for developers, code snippet search, searchable code library, reusable code blocks, prompt engineering tools, prompt template management, collaborative coding, cross-team knowledge sharing, code snippet versioning, AI prompt templates, technical documentation tools, developer productivity suite, team snippet repository, AI prompt history, snippet synchronization, cloud snippet backup, markdown snippet support, syntax highlighting for snippets, code categorization, programming language snippets, language-specific code templates, contextual code suggestions, snippets with AI integration, command palette for snippets, code snippet folder organization, team snippet discovery, private and public snippets, enterprise code management, team codebase documentation, prompt engineering best practices, Vibe Coding, Vibe Coding for developers, Vibe Coding for AI, Vibe Coding for ChatGPT, Vibe Coding for email, Vibe Coding for text, Vibe Coding for keyboard shortcuts, Vibe Coding for text expansion, Vibe Coding for text snippets, Vibe Coding for text replacement, free prompt generator, ai prompt generator, prompt generator, promptlayer, promptimize ai, langchain prompt management, lanhsmith prompt management, latitude, langchain, langgraph, langchain documentation, raycast, text expander, raycast snippets, raycast mac, cursor, cursro ai, cursor snippets, cursor rules, cursor ai rules, learn prompting, how to prompt, prompting guide, prompting tutorials, best prompting practices, ai prompt best practices, prompting techniques, prompting, swift, ios, performance, accessibility, python, go, django, electron, spa, api, php, express, logging, security, testing
AI Prompts, ChatGPT, Code Snippets, Prompt Engineering