When a user visits a particular URL on a Drupal site, the path they are visiting is a route. Drupal's routing system helps figure out which controller is responsible for responding to the route being requested. Drupal matches the incoming request's path to a controller by looking through the routes that have been registered in active modules.
- Create your own routes in custom modules
- Understand how Drupal's routing system maps paths to controllers
At this point in the development cycle of Drupal the routing system is relatively stable. This is mainly because Drupal's routing system leverages the Symfony routing component.
This tutorial walks through the process of creating a custom content entity. Since there are several url paths that will display various types of information about our custom entity there are multiple examples of registering routes in this tutorial as well.
Routing system overview (Drupal.org)
- The main entry point for Drupal's official documentation about the routing system.
Symfony's routing component (symfony.com)
- The official documentation for the Symfony routing component that Drupal's routing system is based on.
Structure of routes (Drupal.org)
- This page in particular covers the variety of configuration options that make up routing configuration files.
Examples project’s page_example module (git.drupalcode.org)
- The Examples for Developers project contains many sub-modules that demonstrate various Drupal sub-systems through well-documented code. To learn more about how routing and controllers work, take a look at the Examples for Developers project's page_example module.