Form generation

  1. 7.x drupal/includes/form.inc form_api
  2. 6.x drupal/includes/form.inc form_api
  3. 8.x drupal/core/includes/form.inc form_api

Functions to enable the processing and display of HTML forms.

Drupal uses these functions to achieve consistency in its form processing and presentation, while simplifying code and reducing the amount of HTML that must be explicitly generated by modules.

The primary function used with forms is drupal_get_form(), which is used for forms presented interactively to a user. Forms can also be built and submitted programmatically without any user input using the drupal_form_submit() function.

drupal_get_form() handles retrieving, processing, and displaying a rendered HTML form for modules automatically.

Here is an example of how to use drupal_get_form() and a form builder function:

$form = drupal_get_form('my_module_example_form');
...
function my_module_example_form($form, &$form_state) {
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Submit'),
  );
  return $form;
}
function my_module_example_form_validate($form, &$form_state) {
  // Validation logic.
}
function my_module_example_form_submit($form, &$form_state) {
  // Submission logic.
}

Or with any number of additional arguments:

$extra = "extra";
$form = drupal_get_form('my_module_example_form', $extra);
...
function my_module_example_form($form, &$form_state, $extra) {
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => $extra,
  );
  return $form;
}

The $form argument to form-related functions is a structured array containing the elements and properties of the form. For information on the array components and format, and more detailed explanations of the Form API workflow, see the Form API reference and the Form API documentation section. In addition, there is a set of Form API tutorials in the Form Example Tutorial which provide basics all the way up through multistep forms.

In the form builder, validation, submission, and other form functions, $form_state is the primary influence on the processing of the form and is passed by reference to most functions, so they use it to communicate with the form system and each other.

See drupal_build_form() for documentation of $form_state keys.

Functions

Namesort ascending Location Description
_form_validate drupal/includes/form.inc Performs validation on form elements.
_form_set_class drupal/includes/form.inc Sets a form element's class attribute.
_form_options_flatten drupal/includes/form.inc Iterates over an array and returns a flat array with duplicate keys removed.
_form_element_triggered_scripted_submission drupal/includes/form.inc Detects if an element triggered the form submission via Ajax.
_form_button_was_clicked drupal/includes/form.inc Determines if a given button triggered the form submission.
_form_builder_handle_input_element drupal/includes/form.inc Adds the #name and #value properties of an input element before rendering.
weight_value drupal/includes/form.inc Sets the value for a weight element, with zero as a default.
theme_vertical_tabs drupal/includes/form.inc Returns HTML for an element's children fieldsets as vertical tabs.
theme_textfield drupal/includes/form.inc Returns HTML for a textfield form element.
theme_textarea drupal/includes/form.inc Returns HTML for a textarea form element.
theme_tableselect drupal/includes/form.inc Returns HTML for a table with radio buttons or checkboxes.
theme_submit drupal/includes/form.inc Returns HTML for a submit button form element.
theme_select drupal/includes/form.inc Returns HTML for a select form element.
theme_radios drupal/includes/form.inc Returns HTML for a set of radio button form elements.
theme_radio drupal/includes/form.inc Returns HTML for a radio button form element.
theme_password drupal/includes/form.inc Returns HTML for a password form element.
theme_image_button drupal/includes/form.inc Returns HTML for an image button form element.
theme_hidden drupal/includes/form.inc Returns HTML for a hidden form element.
theme_form_required_marker drupal/includes/form.inc Returns HTML for a marker for required form elements.
theme_form_element_label drupal/includes/form.inc Returns HTML for a form element label and required marker.
theme_form_element drupal/includes/form.inc Returns HTML for a form element.
theme_form drupal/includes/form.inc Returns HTML for a form.
theme_file drupal/includes/form.inc Returns HTML for a file upload form element.
theme_fieldset drupal/includes/form.inc Returns HTML for a fieldset form element and its children.
theme_date drupal/includes/form.inc Returns HTML for a date selection form element.
theme_container drupal/includes/form.inc Returns HTML to wrap child elements in a container.
theme_checkboxes drupal/includes/form.inc Returns HTML for a set of checkbox form elements.
theme_checkbox drupal/includes/form.inc Returns HTML for a checkbox form element.
theme_button drupal/includes/form.inc Returns HTML for a button form element.
password_confirm_validate drupal/includes/form.inc Validates a password_confirm element.
map_month drupal/includes/form.inc Helper function for usage with drupal_map_assoc to display month names.
form_validate_machine_name drupal/includes/form.inc Form element validation handler for machine_name elements.
form_type_token_value drupal/includes/form.inc Determines the value for form's token value.
form_type_textfield_value drupal/includes/form.inc Determines the value for a textfield form element.
form_type_tableselect_value drupal/includes/form.inc Determines the value for a tableselect form element.
form_type_select_value drupal/includes/form.inc Determines the value for a select form element.
form_type_radios_value drupal/includes/form.inc Form value callback: Determines the value for a #type radios form element.
form_type_password_confirm_value drupal/includes/form.inc Determines the value for a password_confirm form element.
form_type_image_button_value drupal/includes/form.inc Determines the value for an image button form element.
form_type_checkbox_value drupal/includes/form.inc Determines the value for a checkbox form element.
form_type_checkboxes_value drupal/includes/form.inc Determines the value for a checkboxes form element.
form_state_values_clean drupal/includes/form.inc Removes internal Form API elements and buttons from submitted form values.
form_state_keys_no_cache drupal/includes/form.inc Returns an array of $form_state keys that shouldn't be cached.
form_state_defaults drupal/includes/form.inc Retrieves default values for the $form_state array.
form_set_value drupal/includes/form.inc Changes submitted form values during form validation.
form_set_error drupal/includes/form.inc Files an error against a form element.
form_set_cache drupal/includes/form.inc Stores a form in the cache.
form_select_options drupal/includes/form.inc Converts an array of options into HTML, for use in select list form elements.
form_process_weight drupal/includes/form.inc Expands a weight element into a select element.
form_process_vertical_tabs drupal/includes/form.inc Creates a group formatted as vertical tabs.
form_process_tableselect drupal/includes/form.inc Creates checkbox or radio elements to populate a tableselect table.
form_process_select drupal/includes/form.inc Processes a select list form element.
form_process_radios drupal/includes/form.inc Expands a radios element into individual radio elements.
form_process_password_confirm drupal/includes/form.inc Expand a password_confirm field into two text boxes.
form_process_machine_name drupal/includes/form.inc Processes a machine-readable name form element.
form_process_fieldset drupal/includes/form.inc Arranges fieldsets into groups.
form_process_date drupal/includes/form.inc Expands a date element into year, month, and day select elements.
form_process_container drupal/includes/form.inc Processes a container element.
form_process_checkboxes drupal/includes/form.inc Processes a checkboxes form element.
form_process_checkbox drupal/includes/form.inc Sets the #checked property of a checkbox element.
form_process_actions drupal/includes/form.inc Processes a form actions container element.
form_pre_render_fieldset drupal/includes/form.inc Adds members of this group as actual elements for rendering.
form_pre_render_conditional_form_element drupal/includes/form.inc Adds form element theming to an element if its title or description is set.
form_options_flatten drupal/includes/form.inc Allows PHP array processing of multiple select options with the same value.
form_load_include drupal/includes/form.inc Ensures an include file is loaded whenever the form is processed.
form_get_options drupal/includes/form.inc Returns the indexes of a select element's options matching a given key.
form_get_errors drupal/includes/form.inc Returns an associative array of all errors.
form_get_error drupal/includes/form.inc Returns the error message filed against the given form element.
form_get_cache drupal/includes/form.inc Fetches a form from cache.
form_execute_handlers drupal/includes/form.inc Executes custom validation and submission handlers for a given form.
form_error drupal/includes/form.inc Flags an element as having an error.
form_clear_error drupal/includes/form.inc Clears all errors against all form elements made by form_set_error().
form_builder drupal/includes/form.inc Builds and processes all elements in the structured form array.
element_validate_number drupal/includes/form.inc Form element validation handler for number elements.
element_validate_integer_positive drupal/includes/form.inc Form element validation handler for integer elements that must be positive.
element_validate_integer drupal/includes/form.inc Form element validation handler for integer elements.
drupal_validate_form drupal/includes/form.inc Validates user-submitted form data in the $form_state array.
drupal_retrieve_form drupal/includes/form.inc Retrieves the structured array that defines a given form.
drupal_redirect_form drupal/includes/form.inc Redirects the user to a URL after a form has been processed.
drupal_rebuild_form drupal/includes/form.inc Constructs a new $form from the information in $form_state.
drupal_process_form drupal/includes/form.inc Processes a form submission.
drupal_prepare_form drupal/includes/form.inc Prepares a structured form array.
drupal_get_form drupal/includes/form.inc Returns a renderable form array for a given form ID.
drupal_form_submit drupal/includes/form.inc Retrieves, populates, and processes a form.
drupal_build_form drupal/includes/form.inc Builds and process a form based on a form id.
date_validate drupal/includes/form.inc Validates the date type to prevent invalid dates (e.g., February 30, 2006).

File

drupal/includes/form.inc, line 25
Functions for form and batch generation and processing.