How to make a custom module form appear in the admin config

I have a custom module I’m working on and I’d like to make it configurable via the admin menu. I’m having difficulty getting a form to appear in the admin page. Here is my file structure so far (excluding irrelevant files):

*The form file is just an example form to try to get it to appear on the admin page.

MYMODULE.routing.yml

MYMODULE.settings:   path: '/admin/config/MYMODULE'   defaults:     _form: 'DrupalMYMODULEFormmyModuleSettingsForm'     _title: 'myModule Settings'   requirements:     _permission: 'administer site configuration' 

MYMODULE.schema.yml

MYMODULE.settings:   type: config_object   label: 'myModule Settings'   mapping:     path_to_sound:       type: string       label: 'Path to Sound' 

MYMODULE.links.menu.yml

MYMODULE.settings:   title: 'myModule Settings'   description: 'Alter myModule Settings'   route_name: MYMODULE.settings   parent: system.admin_config 

MYMODULE.settings.yml

path:   path_to_sound: '/modules/custom/MYMODULE/myModule.mp3' 

myModuleSettingsForm.php

<?php  namespace DrupalMYMODULEForm;  use DrupalCoreFormConfigFormBase; use DrupalCoreFormFormStateInterface;  /**  * Configure example settings for this site.  */ class myModuleSettingsForm extends ConfigFormBase {    /**    * Config settings.    *    * @var string    */   const SETTINGS = 'MYMODULE.settings';    /**    * {@inheritdoc}    */   public function getFormId() {     return 'MYMODULE_admin_settings';   }    /**    * {@inheritdoc}    */   protected function getEditableConfigNames() {     return [       static::SETTINGS,     ];   }    /**    * {@inheritdoc}    */   public function buildForm(array $form, FormStateInterface $form_state) {     $config = $this->config(static::SETTINGS);      $form['example_thing'] = [       '#type' => 'textfield',       '#title' => $this->t('Things'),       '#default_value' => $config->get('example_thing'),     ];      return parent::buildForm($form, $form_state);   }    /**    * {@inheritdoc}    */   public function submitForm(array &$form, FormStateInterface $form_state) {     // Retrieve the configuration.     $this->configFactory->getEditable(static::SETTINGS)       // Set the submitted configuration setting.       ->set('example_thing', $form_state->getValue('example_thing'))       // You can set multiple configurations at once by making       // multiple calls to set().       ->save();      parent::submitForm($form, $form_state);   }  } 

It’s my understanding that I should now be able to see this form on the config page, but I do not, regardless of cache clearing, etc. I followed documentation to do this and even cross referenced other popular modules, so I’m really not sure what I’m doing wrong.

This article was republished from its original source.
Call Us: 1(800)730-2416

Pixeldust is a 20-year-old web development agency specializing in Drupal and WordPress and working with clients all over the country. With our best in class capabilities, we work with small businesses and fortune 500 companies alike. Give us a call at 1(800)730-2416 and let’s talk about your project.

FREE Drupal SEO Audit

Test your site below to see which issues need to be fixed. We will fix them and optimize your Drupal site 100% for Google and Bing. (Allow 30-60 seconds to gather data.)

Powered by

How to make a custom module form appear in the admin config

On-Site Drupal SEO Master Setup

We make sure your site is 100% optimized (and stays that way) for the best SEO results.

With Pixeldust On-site (or On-page) SEO we make changes to your site’s structure and performance to make it easier for search engines to see and understand your site’s content. Search engines use algorithms to rank sites by degrees of relevance. Our on-site optimization ensures your site is configured to provide information in a way that meets Google and Bing standards for optimal indexing.

This service includes:

  • Pathauto install and configuration for SEO-friendly URLs.
  • Meta Tags install and configuration with dynamic tokens for meta titles and descriptions for all content types.
  • Install and fix all issues on the SEO checklist module.
  • Install and configure XML sitemap module and submit sitemaps.
  • Install and configure Google Analytics Module.
  • Install and configure Yoast.
  • Install and configure the Advanced Aggregation module to improve performance by minifying and merging CSS and JS.
  • Install and configure Schema.org Metatag.
  • Configure robots.txt.
  • Google Search Console setup snd configuration.
  • Find & Fix H1 tags.
  • Find and fix duplicate/missing meta descriptions.
  • Find and fix duplicate title tags.
  • Improve title, meta tags, and site descriptions.
  • Optimize images for better search engine optimization. Automate where possible.
  • Find and fix the missing alt and title tag for all images. Automate where possible.
  • The project takes 1 week to complete.