Checklist API allows modules to create dynamic checklists that track user progress and completion times. It handles menu items and permissions for these checklists.
Checklist API Provides a simple interface for modules to create fillable, persistent checklists that track progress with completion times and users. You don't need this unless you're a module developer or you want to use a module that calls for it.
Installation
Checklist API is installed in the usual way. See Installing contributed modules.
Implementation
Checklists are declared as multidimensional arrays using hook_checklistapi_checklist_info(). They can be altered using hook_checklistapi_checklist_info_alter(). Checklist API handles creation of menu items and permissions. In Drupal 7, progress details are saved in one Drupal variable per checklist. In Drupal 8, they are stored in one config file per checklist. (Note: it is the responsibility of implementing modules to remove their own variables/config on hook_uninstall(). See checklistapiexample_uninstall() for an example.)
See checklistapi_example.module for an example implementation and checklistapi.api.php for complete details.
Drush
Checklist API provides Drush commands. They require Drush 6 or later. To see the list of available commands, run drush --filter=checklistapi. For more about Drush, including installation instructions, visit http://www.drush.org/.
Project status/maintenance
I (TravisCarden) no longer have any personal need for this module as my work has taken me in other directions. The following people have generously offered to co-maintain it.
Branch maintainers
9.x - 11.x
7.x
Ask your assistant about Checklist API
Check compatibility with your Drupal and PHP version, maintenance and security coverage, from current release data. How it works
Depends on
Dependencies of the latest stable release
No dependencies recorded for this project.
Required by
8 tracked projects depend on this one
- SEO Checklist 20,683 sites
- Language Checklist 3,723 sites
- General Data Protection Regulation 2,150 sites
- Droopler 233 sites
- AI Checklist 110 sites
- Opquast checklist 80 sites
- A11Y Project Checklist 7 sites
- Digital Marketing Checklist
Activity
Release Timeline
Releases
| Version | Type | Core | PHP | Release date | |
|---|---|---|---|---|---|
| 2.1.7 | Stable | 9–11 | Nov 21, 2025 | ||
| 3.0.x-dev | Dev | 10–11 | Sep 13, 2024 | ||
| 2.1.6 | Stable | 9–11 | PHP >=7.3.0 | Apr 22, 2024 | |
| 2.1.5 | Stable | 9–10 | PHP >=7.3.0 | Oct 18, 2023 | |
| 2.1.4 | Stable | 9–10 | PHP >=5.6.0 | Oct 17, 2023 | |
| 2.1.3 | Stable | 9–10 | PHP >=5.6.0 | Jun 23, 2023 | |
| 2.1.x-dev | Dev | 9–11 | PHP >=7.3.0 | Apr 7, 2023 | |
| 2.1.2 | Stable | 9–10 | PHP >=5.6.0 | Apr 6, 2023 |