How to use Form API

Question

I'm new to drupal, and especially new to drupal form API. I see all the documentation which seems to make sense. They miss one key instruction that you need to create .module / .info files. I have created those, and copied the code from into my module Form example code drupal 6 However, I don't know how to view the module.

I know that if I can get a working example, I will be fine, but I can't. I am lost, and no matter how far I search all the guides miss the early steps, or make too much of an assumption.

test_form.info

name = Form example
description = My form example form API.
core = 6.x
package = Example form

test_form.module

function MYMODULE_menu() {
  $items['some/form'] = array(
    'title' => 'Some Form',
    'access arguments' => array('access content'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('MYMODULE_some_form'),
  );

  return $items;
}

function MYMODULE_some_form($form_state) {
  $form['item'] = array(
    '#type' => 'textfield',
    '#title' => t('Title'),
    '#required' => TRUE,
    '#default_value' => 'Default...',
  );

  return $form;
}

Answer 1

Rather than keep this going in the comments, here's a very basic form/menu example (un-tested but it should work).

function MYMODULE_menu() {
  $items['some/form'] = array(
    'title' => 'Some Form',
    'access arguments' => array('access content'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('MYMODULE_some_form'),
  );

  return $items;
}

function MYMODULE_some_form($form_state) {
  $form['item'] = array(
    '#type' => 'textfield',
    '#title' => t('Title'),
    '#required' => TRUE,
    '#default_value' => 'Default...',
  );

  return $form;
}

All of the above goes in a single module file. Once you install the new module (or clear the caches if it's already installed), you should see a basic form at /some/form.

Answer 2

I learnt by studying the Examples Module. Install the examples module (https://drupal.org/project/examples), enable form api example sub module in it. Follow the code.

API Documentation: https://api.drupal.org/api/examples/form_example%21form_example.module/group/form_example/7

A simple way to follow would be - look at the hook_menu function.

Look at the code here: http://drupalcode.org/project/examples.git/blob/HEAD:/form_example/form_example.module

The following code snippet builds the page at http://baseurl.com/examples/form_example - you can now follow along.

$items['examples/form_example'] = array(
   'title' => 'Form Example',
   'page callback' => 'form_example_intro',
   'access callback' => TRUE,
   'expanded' => TRUE,
);

Another useful piece of information is the form api examples at: https://api.drupal.org/api/drupal/developer%21topics%21forms_api_reference.html/6

For Drupal 7, look at: https://api.drupal.org/api/drupal/developer%21topics%21forms_api_reference.html/7

Hope this helps.

Answer 3

I was totally new to drupal, drupal modules (creating) and the form API.

Here is the basics to getting a simple form loaded with the menu link. Note the credits go to @Clive.

First of all I have a module in the module folder as follows.

formpractice - folder

--MYMODULE.info

name = My Test Form

description = A very simple Test Form to get you up and running.

core = 7.x

--MYMODULE.module (It is important that the MYMODULE_menu = the module name. So in this case at the module is called MYMODULE thats what is here replacing the hook_menu. This was my main reason for my module not loading the simple form. I had called my module something different to what the hook_menu was utilising.Then from here the form is the 2nd function, that can be further developed using the API instructions. I hope this helps any new users to getting started with the FORM API.

<?php function MYMODULE_menu() {
$items['some/form'] = array(
'title' => 'Some Form',
'access arguments' => array('access content'),
'page callback' => 'drupal_get_form',
'page arguments' => array('MYMODULE_some_form'),
);

 return $items;
}

function MYMODULE_some_form($form_state) {
 $form['item'] = array(
'#type' => 'textfield',
'#title' => t('Title'),
'#required' => TRUE,
'#default_value' => 'Default...',
 );

 return $form;
}