1. 4.6.x includes/common.inc form
  2. 4.7.x includes/form.inc form
  3. 5.x includes/form.inc form

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 drupal_get_form() function handles retrieving, processing, and displaying a rendered HTML form for modules automatically. For example:

// Display the user registration form.
$output = drupal_get_form('user_register');

Forms can also be built and submitted programmatically without any user input using the drupal_execute() function.

For information on the format of the structured arrays used to define forms, and more detailed explanations of the Form API workflow, see the reference and the quickstart guide.

File

includes/form.inc, line 3

Functions

Namesort descending Location Description
checkboxes_value includes/form.inc Helper function to load value from default value for checkboxes.
date_validate includes/form.inc Validates the date type to stop dates like February 30, 2006.
drupal_execute includes/form.inc Retrieves a form using a form_id, populates it with $form_values, processes it, and returns any validation errors encountered. This function is the programmatic counterpart to drupal_get_form().
drupal_get_form includes/form.inc Retrieves a form from a builder function, passes it on for processing, and renders the form or redirects to its destination as appropriate. In multi-step form scenarios, it handles properly processing the values using the previous step's form…
drupal_prepare_form includes/form.inc Prepares a structured form array by adding required elements, executing any hook_form_alter functions, and optionally inserting a validation token to prevent tampering.
drupal_process_form includes/form.inc This function is the heart of form API. The form gets built, validated and in appropriate cases, submitted.
drupal_redirect_form includes/form.inc Redirect the user to a URL after a form has been processed.
drupal_render_form includes/form.inc Renders a structured form array into themed HTML.
drupal_retrieve_form includes/form.inc Retrieves the structured array that defines a given form.
drupal_submit_form includes/form.inc Processes user-submitted form data from a global variable using the submit functions defined in a structured form array.
drupal_validate_form includes/form.inc Validates user-submitted form data from a global variable using the validate functions defined in a structured form array.
expand_checkboxes includes/form.inc
expand_date includes/form.inc Roll out a single date element.
expand_password_confirm includes/form.inc Expand a password_confirm field into two text boxes.
expand_radios includes/form.inc Roll out a single radios element to a list of radios, using the options array as index.
form_builder includes/form.inc Adds some required properties to each form element, which are used internally in the form API. This function also automatically assigns the value property from the $edit array, provided the element doesn't already have an assigned value.
form_clean_id includes/form.inc Remove invalid characters from an HTML ID attribute string.
form_error includes/form.inc Flag an element as having an error.
form_get_error includes/form.inc Return the error message filed against the form with the specified name.
form_get_errors includes/form.inc Return an associative array of all errors.
form_get_options includes/form.inc Traverses a select element's #option array looking for any values that hold the given key. Returns an array of indexes that match.
form_options_flatten includes/form.inc
form_select_options includes/form.inc
form_set_error includes/form.inc File an error against a form element. If the name of the element is edit[foo][bar] then you may pass either foo or foo][bar as $name foo will set an error for all its children.
form_set_value includes/form.inc Use this function to make changes to form values in the form validate phase, so they will be available in the submit phase in $form_values.
map_month includes/form.inc Helper function for usage with drupal_map_assoc to display month names.
password_confirm_validate includes/form.inc Validate password_confirm element.
process_weight includes/form.inc Expand weight elements into selects.
theme_button includes/form.inc
theme_checkbox includes/form.inc Format a checkbox.
theme_checkboxes includes/form.inc Format a set of checkboxes.
theme_date includes/form.inc Format a date selection element.
theme_fieldset includes/form.inc Format a group of form items.
theme_file includes/form.inc Format a file upload field.
theme_form includes/form.inc Format a form.
theme_form_element includes/form.inc Return a themed form element.
theme_hidden includes/form.inc Format a hidden form field.
theme_item includes/form.inc Format a form item.
theme_markup includes/form.inc
theme_password includes/form.inc Format a password field. *
theme_password_confirm includes/form.inc Format a password_confirm item.
theme_radio includes/form.inc Format a radio button.
theme_radios includes/form.inc Format a set of radio buttons.
theme_select includes/form.inc Format a dropdown menu or scrolling selection box.
theme_submit includes/form.inc
theme_textarea includes/form.inc Format a textarea.
theme_textfield includes/form.inc Format a textfield.
theme_token includes/form.inc
weight_value includes/form.inc If no default value is set for weight select boxes, use 0.
_drupal_clean_form_sessions includes/form.inc Remove form information that's at least a day old from the $_SESSION['form'] array.
_element_info includes/form.inc Retrieve the default properties for the defined element type.
_form_set_class includes/form.inc Sets a form element's class attribute.
_form_set_value includes/form.inc Helper function for form_set_value().
_form_validate includes/form.inc Performs validation on form elements. First ensures required fields are completed, #maxlength is not exceeded, and selected options were in the list of options given to the user. Then calls user-defined validators.