The Rules module enables site administrators to create custom logic by defining actions that execute based on specific events. This allows for the automation of tasks such as content publishing workflows, custom notifications, and more, all without requiring extensive coding.
The Rules module allows site administrators to define conditionally executed actions based on occurring events (known as reactive or ECA rules).
Example use cases
- Build flexible content publishing workflows changes
- Send customized mails to notify your users about important
- Create custom redirections, system messages, breadcrumbs, ...
And many more...
Features
- Obviously, you may use reaction rules to react upon any event with custom conditions and actions.
- Allows functionality to be re-used via components.
- Flexible scheduling system that allows scheduling any component / action.
- Users can share their customizations by using the built-in import/export feature.
- Modular input evaluation system - for example you can install the Token module and use it in every action.
- The module has been developed with site performance in mind, so it makes use of caching routines to speed up rule evaluation.
Integrations
Modules may use the Rules module's API to provide new events, conditions, actions or default rules, which can be customized by users. Some notable ones are:
- Rules Link - Provides clickable links on entities and views that trigger Rules execution
- Rules list conditions - Allows checking condition(s) on list items, evaluating to TRUE if either "any" or "all" items match the condition(s)
- Views Rules - Provides Views directly as Rules actions and loops to seamlessly use view result data
- Rules Forms - Provides a Rules based method for controlling forms and their elements
- Conditional Rules - Provides inline conditional branching in Rules configuration with statements: If/Else, Switch/Case, While
To make your own integration, check out the developer docs. See also issues tagged rules-integration and a manually updated list of modules supporting Rules.
Requirements
Resources
- Rules Essentials Documentation Handbook
- api.drupal.org/api/rules - API Reference for developers. Covers Drupal 7, Drupal 8, Drupal 9, and Drupal 10.
Maintainers
- Tim Rohaly (TR)
- Wolfgang Ziegler (fago) (maintainer emeritus)