API reference

Primary tabs

• Drupal 4.6.x
• Drupal 4.7.x
• Drupal 5.x
• Drupal 6.x
• Drupal 7.x
• Drupal 8.0.x
• Drupal 8.1.x
• Drupal 8.2.x
• Drupal 8.3.x
• Drupal 8.4.x
• Drupal 8.5.x
• Drupal 8.6.x
• Drupal 8.7.x
• Drupal 8.8.x
• Drupal 8.9.x
• Drupal 9.0.x(active tab)
• Drupal 9.1.x
• Drupal 9.2.x

Welcome to the Drupal API Documentation!

This site is an API reference for Drupal, generated from comments embedded in the source code. More in-depth documentation can be found at https://www.drupal.org/developing/api.

Here are some topics to help you get started developing with Drupal.

Essential background concepts

• Object-oriented conventions used in Drupal
• Extending and altering Drupal
• Security and best practices
• Types of information in Drupal

User interface

• Menu entries, local tasks, and other links
• Routing API and page controllers
• Forms
• Blocks
• Ajax

Storing and retrieving data

• Entities
• Fields
• Configuration API
• State API
• Views
• Database abstraction layer

Other essential APIs

• Plugins
• Services and the Dependency Injection Container
• Events
• Internationalization
• Caching
• Utility classes and functions
• User accounts, permissions, and roles
• Render API
• Theme system
• Update API
• Migration

Additional topics

• Batch API
• Queue API
• Typed Data
• Automated tests
• PHP Runtime Assert Statements
• Integrating third-party applications

Further information

• All topics
• Examples project (sample modules)
• API change notices
• Drupal 8 API longer references