Automatic Configuration Form
This module automatically generates configuration forms for your Drupal modules based on their schema definitions. It simplifies the process of creating forms, especially for simple modules or limited user bases, by eliminating the need for manual form coding.
The Schema form module can do everything that this module does, and more. I will continue to fix bugs in this module, but development of new features should happen in Schema form.
Generate your custom module's configuration form automatically from its schema definitions.
Writing config forms is boring. Mostly they all look the same, or are not very important, especially if it's for simple or small modules or for a limited amount of users. So let's automate it!
Example
If your module has config, it will have a schema file, e.g. at my_module/config/schema/my_module.schema.yml. Here is an example:
my_module.settings:
type: config_object
label: 'My module settings'
translatable: false
mapping:
foo:
type: string
title: 'Foo'
label: 'How much foo?'
bar:
type: boolean
title: 'Enable bar'
label: 'Whether to run bar or not.'
To create an automatic config form using this schema, create my_module/Form/ConfigForm.php with the following:
namespace Drupal\my_module\Form;
use Drupal\auto_config_form\AutoConfigFormBase;
/**
* Settings form for my module.
*
* @package Drupal\my_module\Form
*/
class ConfigForm extends AutoConfigFormBase {
/**
* {@inheritDoc}
*/
protected function getSchemaKey(): string {
return 'my_module.settings';
}
}
That's it!
Next steps
- If you need to customize anything, just override some of the methods of AutoConfigFormBase.
- To make the settings page accessible, you need to add a route. See https://www.drupal.org/docs/drupal-apis/routing-system/introductory-drup... .
- To make your route available in a menu, see https://www.drupal.org/docs/drupal-apis/menu-api/providing-module-define... .
Drupal core compatibility
- Drupal 10: Use version 1.x
- Drupal 11: Use version 2.x
Drupal 10 needs protected $typedConfigManager; and Drupal 11 needs protected TypedConfigManagerInterface $typedConfigManager;, and they are mutually exclusive. This forces us to maintain separate versions of this module for Drupal 10 and Drupal 11. See https://www.drupal.org/project/auto_config_form/issues/3532554 and https://www.drupal.org/project/auto_config_form/issues/3412011 for where we accidentally messed this up twice.
Similar modules
- Automatic Configuration Form (this module): Started September 2021
- Schema-based config forms Started April 2023
- Schema form Started April 2025