function hook_forms

You are here

7 system.api.php hook_forms($form_id, $args)
5 core.php hook_forms()
6 core.php hook_forms($form_id, $args)

Map form_ids to builder functions.

This hook allows modules to build multiple forms from a single form "factory" function but each form will have a different form id for submission, validation, theming or alteration by other modules.

The callback arguments will be passed as parameters to the function. Callers of drupal_get_form() are also able to pass in parameters. These will be appended after those specified by hook_forms().

See node_forms() for an actual example of how multiple forms share a common building function.

Return value

An array keyed by form id with callbacks and optional, callback arguments.

Related topics

3 functions implement hook_forms()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

node_forms in modules/node/node.module
Implementation of hook_forms(). All node forms share the same form handler
search_forms in modules/search/search.module
user_forms in modules/user/user.module
1 invocation of hook_forms()
drupal_retrieve_form in includes/form.inc
Retrieves the structured array that defines a given form.

File

developer/hooks/core.php, line 466
These are the hooks that are invoked by the Drupal core.

Code

function hook_forms() {
  $forms['mymodule_first_form'] = array(
    'callback' => 'mymodule_form_builder',
    'callback arguments' => array('some parameter'),
  );
  $forms['mymodule_second_form'] = array(
    'callback' => 'mymodule_form_builder',
  );
  return $forms;
}