Documentation & API reference
Functions
Primary tabs
| Name |
Location |
Description | Direct uses | Strings |
|---|---|---|---|---|
| form_load_include |
drupal/ |
Ensures an include file is loaded whenever the form is processed. | 1 | |
| drupal_form_submit |
drupal/ |
Retrieves, populates, and processes a form. | 6 | |
| drupal_retrieve_form |
drupal/ |
Retrieves the structured array that defines a given form. | 3 | |
| drupal_process_form |
drupal/ |
Processes a form submission. | 7 | |
| drupal_prepare_form |
drupal/ |
Prepares a structured form array. | 7 | |
| drupal_validate_form |
drupal/ |
Validates user-submitted form data in the $form_state array. | 1 | |
| drupal_redirect_form |
drupal/ |
Redirects the user to a URL after a form has been processed. | 2 | |
| _form_validate |
drupal/ |
Performs validation on form elements. | 1 | |
| form_execute_handlers |
drupal/ |
Executes custom validation and submission handlers for a given form. | 3 | |
| form_set_error |
drupal/ |
Files an error against a form element. | 85 | 1 |
| form_clear_error |
drupal/ |
Clears all errors against all form elements made by form_set_error(). | 3 | |
| form_get_errors |
drupal/ |
Returns an associative array of all errors. | 12 | |
| form_get_error |
drupal/ |
Returns the error message filed against the given form element. | 1 | |
| form_error |
drupal/ |
Flags an element as having an error. | 28 | |
| form_builder |
drupal/ |
Builds and processes all elements in the structured form array. | 3 | |
| _form_builder_handle_input_element |
drupal/ |
Adds the #name and #value properties of an input element before rendering. | 1 | |
| _form_element_triggered_scripted_submission |
drupal/ |
Detects if an element triggered the form submission via Ajax. | 1 | |
| _form_button_was_clicked |
drupal/ |
Determines if a given button triggered the form submission. | 1 | |
| form_state_values_clean |
drupal/ |
Removes internal Form API elements and buttons from submitted form values. | 8 | |
| form_type_image_button_value |
drupal/ |
Determines the value for an image button form element. | ||
| form_type_checkbox_value |
drupal/ |
Determines the value for a checkbox form element. | ||
| form_type_checkboxes_value |
drupal/ |
Determines the value for a checkboxes form element. | ||
| form_type_tableselect_value |
drupal/ |
Determines the value for a tableselect form element. | ||
| form_type_radios_value |
drupal/ |
Form value callback: Determines the value for a #type radios form element. | ||
| form_type_password_confirm_value |
drupal/ |
Determines the value for a password_confirm form element. | ||
| form_type_select_value |
drupal/ |
Determines the value for a select form element. | ||
| form_type_textfield_value |
drupal/ |
Determines the value for a textfield form element. | 1 | 1 |
| form_type_token_value |
drupal/ |
Determines the value for form's token value. | ||
| form_set_value |
drupal/ |
Changes submitted form values during form validation. | 24 | |
| form_options_flatten |
drupal/ |
Allows PHP array processing of multiple select options with the same value. | 3 | |
| _form_options_flatten |
drupal/ |
Iterates over an array and returns a flat array with duplicate keys removed. | 1 | 1 |
| form_process_select |
drupal/ |
Processes a select list form element. | 1 | |
| theme_select |
drupal/ |
Returns HTML for a select form element. | ||
| form_select_options |
drupal/ |
Converts an array of options into HTML, for use in select list form elements. | 1 | |
| form_get_options |
drupal/ |
Returns the indexes of a select element's options matching a given key. | ||
| theme_fieldset |
drupal/ |
Returns HTML for a fieldset form element and its children. | ||
| theme_radio |
drupal/ |
Returns HTML for a radio button form element. | ||
| theme_radios |
drupal/ |
Returns HTML for a set of radio button form elements. | ||
| form_process_password_confirm |
drupal/ |
Expand a password_confirm field into two text boxes. | 1 | |
| password_confirm_validate |
drupal/ |
Validates a password_confirm element. | 1 | |
| theme_date |
drupal/ |
Returns HTML for a date selection form element. | ||
| form_process_date |
drupal/ |
Expands a date element into year, month, and day select elements. | 1 | |
| date_validate |
drupal/ |
Validates the date type to prevent invalid dates (e.g., February 30, 2006). | 1 | |
| map_month |
drupal/ |
Helper function for usage with drupal_map_assoc to display month names. | 1 | 1 |
| weight_value |
drupal/ |
Sets the value for a weight element, with zero as a default. | ||
| form_process_radios |
drupal/ |
Expands a radios element into individual radio elements. | 1 | |
| theme_checkbox |
drupal/ |
Returns HTML for a checkbox form element. | ||
| theme_checkboxes |
drupal/ |
Returns HTML for a set of checkbox form elements. | ||
| form_pre_render_conditional_form_element |
drupal/ |
Adds form element theming to an element if its title or description is set. | 1 | |
| form_process_checkbox |
drupal/ |
Sets the #checked property of a checkbox element. | 1 |