SEO Checklist
seo_checklist
Provides an interactive checklist to guide site administrators through implementing SEO best practices on Drupal websites using the Checklist API module.
Overview
The SEO Checklist module provides a comprehensive, interactive checklist that guides Drupal site administrators through the essential steps of implementing search engine optimization (SEO) on their websites. While the module itself provides minimal functionality beyond the checklist interface, it serves as an invaluable roadmap for completing on-page and technical SEO tasks.
The checklist is organized into seven key sections covering clean URLs, meta tags and Schema.org vocabularies, search engine setup, content optimization, on-page optimization, security and performance, and mobile optimization. Each section contains specific actionable tasks with links to download recommended modules, install them, configure permissions, and access configuration pages.
One of the module's most useful features is its ability to auto-detect completed tasks. For example, if a recommended module is already installed, the corresponding checkbox will be pre-checked. The module also provides Composer commands for each recommended module directly in the interface, making it easy for developers to install dependencies from the command line.
Progress is saved with timestamps and associated usernames, allowing teams to track who completed which tasks and when. This makes the SEO Checklist particularly valuable for agencies and teams working on multiple Drupal sites or onboarding new team members to SEO best practices.
Install
composer require 'drupal/seo_checklist:^5.2'
Features
- Interactive checklist with 7 organized sections covering comprehensive SEO implementation (Clean URLs, Meta tags, Search engines, Content optimization, On-page optimization, Security/Performance, Mobile)
- Auto-detection of completed tasks - automatically pre-checks items when recommended modules are already installed
- Direct links to download, install, configure permissions, and configure each recommended module
- Composer commands displayed inline for each module to facilitate CLI-based installation
- Progress tracking with timestamps and username association for team collaboration
- External links automatically open in new windows for better user experience
- Toggle display for CLI commands to show or hide Composer installation commands
- SEO Training Camp links providing additional learning resources for specific topics
- Tour integration for guided walkthrough of the checklist interface (via optional submodule)
- Getting started guide explaining how to use the checklist effectively
Use Cases
New Drupal Site SEO Setup
When launching a new Drupal website, use the SEO Checklist to systematically implement all essential SEO best practices. Start from the Clean URLs section and work through each tab, installing and configuring recommended modules as you go. The auto-detection feature will show which modules you've already installed, and the progress tracking lets you save your work and continue later.
SEO Audit for Existing Sites
Use the SEO Checklist to audit an existing Drupal site's SEO implementation. The auto-detection will reveal which SEO modules are already installed, highlighting gaps in your current setup. Work through unchecked items to bring the site up to current SEO best practices.
Agency Workflow Standardization
Digital agencies can use the SEO Checklist as a standard operating procedure for all client sites. The progress tracking with timestamps and usernames provides documentation of who completed each task and when, useful for client reporting and team handoffs.
Team Onboarding and Training
Use the SEO Checklist to train new team members on Drupal SEO best practices. The SEO Training Camp links provide additional learning resources, and the organized structure helps newcomers understand the relationship between different SEO modules and concepts.
Search Engine Submission Workflow
The Search engines section provides a complete workflow for setting up search engine tools including Google Search Console, Bing Webmaster Tools, and XML sitemap submission. Follow the tasks in order to ensure your site is properly indexed by major search engines.
Performance and Security Baseline
Use the Security and performance section to establish a performance and security baseline for your site. Tasks guide you through speed testing, HTTPS setup, CSS/JS aggregation, CDN configuration, and security auditing.
Tips
- Start at the top of the first section and work your way through each tab systematically
- Click Save after completing each item to create a timestamp record - don't wait until the end
- Auto-checked items still need to be saved to record the completion timestamp
- Use the Composer commands displayed for each module to quickly install dependencies via CLI
- External links open in new windows so you don't lose your place in the checklist
- The checklist sections are ordered from most important to least important for prioritization
- Many tasks include Configure links that only appear when the relevant module is installed
- Enable the SEO Checklist Optional Modules submodule to install all recommended modules at once (deprecated)
- The tour feature provides a guided walkthrough for first-time users when the optional modules submodule is enabled
Dependencies
Related Projects
Core dependency that provides the checklist framework and user interface. SEO Checklist uses Checklist API to define and display the interactive checklist.
Recommended module for managing URL redirects from old URLs to new URLs.
Recommended module for automatically generating SEO-friendly URL aliases based on patterns.
Recommended module for managing meta tags and structured data for search engines.
Recommended module for adding JSON-LD structured data to pages.
Recommended module for generating XML sitemaps for search engine submission.
Recommended module for integrating Google Analytics and other tracking scripts.
Recommended module for automatically generating breadcrumb navigation.
Recommended module for on-page SEO analysis and optimization suggestions.
Recommended module for automated security auditing.
Recommended module for adding hreflang tags for multilingual sites.
Recommended module for managing robots.txt file through the admin interface.
Recommended module for generating HTML sitemaps for visitors.
Recommended module for providing search results instead of 404 errors.
Recommended module for comparing content revisions.
Recommended module for customizing file upload paths.
Recommended module for enhanced link options in CKEditor.
Recommended module for CDN and performance optimization integration.
Optional integration providing a guided tour of the SEO Checklist interface when the submodule is enabled.
Admin Pages
| Title | Path | Description |
|---|---|---|
| SEO Checklist | /admin/config/search/seo-checklist |
Main interface for tracking SEO optimization tasks. Provides an organized checklist with seven sections covering all aspects of Drupal SEO. Auto-detects installed modules and pre-checks corresponding tasks. Each task includes links to relevant resources including module download pages, installation pages, configuration pages, and permission settings. |
Hooks
| Hook | Description |
|---|---|
hook_checklistapi_checklist_info |
Defines the SEO Checklist structure and items for the Checklist API module. Returns the checklist definition including title, description, path, callback function, and help text. |