prethiee

Understanding Drupal Form Code

August 2nd, 2024
Drupal Form Configuration Menus Development

Introduction

Creating and customizing forms in Drupal can be daunting, but understanding the code behind these forms can simplify the process. This guide walks through the code generated by Drupal Console to create an admin form, providing insights into routes, menu items, and form methods.

Setting Up Routes

The route file in the module, welcome.routing.yml, maps URLs to the form. Here’s an example:

welcome.admin_settings_form:
 path: '/admin/config/welcome/adminsettings'
 defaults:
   _form: '\Drupal\welcome\Form\AdminSettingsForm'
   _title: 'AdminSettingsForm'
 requirements:
   _permission: 'access administration pages'
 options:
   _admin_route: TRUE

This route links to the form controller AdminSettingsForm. Accessing /admin/config/welcome/adminsettings displays the form.

Adding to the Menu

To make the form accessible via the Drupal menu, the module’s menu link is defined in welcome.links.menu.yml:

welcome.admin_settings_form:
 title: 'Welcome message configuration'
 route_name: welcome.admin_settings_form
 description: 'Welcome message admin'
 parent: system.admin_config_system
 weight: 99
  • Title: Menu link text
  • Route: Previously defined route
  • Description: Appears under the title
  • Parent: Parent menu item
  • Weight: Positioning relative to sibling items

Exploring the Form

The form code resides in welcome/src/Form/AdminSettingsForm.php, which includes essential methods like buildForm() and submitForm().

Building the Form

The buildForm() method constructs the form:

public function buildForm(array $form, FormStateInterface $form_state) {
 $config = $this->config('welcome.adminsettings');
 $form['welcome_message'] = [
   '#type' => 'textarea',
   '#title' => $this->t('Welcome message'),
   '#description' => $this->t('Welcome message display to users when they login'),
   '#default_value' => $config->get('welcome_message'),
 ];
 return parent::buildForm($form, $form_state);
}
  • $config: Loads module configuration
  • Form Elements: Defines a textarea for the welcome message with title, description, and default value

Handling Form Submission

The submitForm() method saves form data:

public function submitForm(array &$form, FormStateInterface $form_state) {
 $this->config('welcome.adminsettings')
   ->set('welcome_message', $form_state->getValue('welcome_message'))
   ->save();
}
  • Configuration: References module configuration
  • Setting Values: Updates configuration with form input
  • Saving Data: Saves updated configuration

Conclusion

Understanding and customizing Drupal forms involves knowing how routes, menus, and form methods work together. With this knowledge, you can confidently create and manage forms in Drupal.