Documentation & API reference
Functions
Primary tabs
| Name |
Location |
Description | Direct uses | Strings |
|---|---|---|---|---|
| _form_set_attributes |
drupal/ |
Sets a form element's class attribute. | 16 | |
| batch_set |
drupal/ |
Adds a new batch. | 25 | |
| batch_process |
drupal/ |
Processes the batch. | 11 | |
| batch_get |
drupal/ |
Retrieves the current batch. | 19 | |
| _batch_populate_queue |
drupal/ |
Populates a job queue with the operations of a batch set. | 2 | |
| _batch_queue |
drupal/ |
Returns a queue object for a batch set. | 3 | |
| drupal_get_form |
drupal/ |
Returns a renderable form array for a given form ID. | 35 | 42 |
| drupal_build_form |
drupal/ |
Builds and processes a form for a given form ID. | 10 | |
| form_state_defaults |
drupal/ |
Retrieves default values for the $form_state array. | 8 | |
| drupal_rebuild_form |
drupal/ |
Constructs a new $form from the information in $form_state. | 2 | |
| form_get_cache |
drupal/ |
Fetches a form from the cache. | 2 | |
| form_set_cache |
drupal/ |
Stores a form in the cache. | 2 | |
| form_state_keys_no_cache |
drupal/ |
Returns an array of $form_state keys that shouldn't be cached. | 2 | |
| form_load_include |
drupal/ |
Ensures an include file is loaded whenever the form is processed. | 4 | |
| drupal_form_submit |
drupal/ |
Retrieves, populates, and processes a form. | 7 | |
| 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. | 6 | |
| 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. | 4 | |
| form_set_error |
drupal/ |
Files an error against a form element. | 88 | 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. | 15 | |
| 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. | 43 | |
| form_builder |
drupal/ |
Builds and processes all elements in the structured form array. | 2 | |
| _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. | 10 | |
| 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_radios_value |
drupal/ |
Form value callback: Determines the value for a #type radios form element. | ||
| form_type_tableselect_value |
drupal/ |
Determines the value for a tableselect 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. | ||
| form_type_token_value |
drupal/ |
Determines the value for form's token value. | ||
| form_set_value |
drupal/ |
Changes submitted form values during form validation. | 27 | |
| form_options_flatten |
drupal/ |
Allows PHP array processing of multiple select options with the same value. | 2 | |
| _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. | 2 | |
| theme_select |
drupal/ |
Returns HTML for a select form element. | ||
| form_select_options |
drupal/ |
Converts a select form element's options array into HTML. | 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_details |
drupal/ |
Returns HTML for a details form element and its children. |