Documentation & API reference
Functions
Primary tabs
Name |
Location | Description | Direct uses | Strings |
|---|---|---|---|---|
| format_size |
drupal/ |
Generates a string representation for the given byte count. | 17 | |
| format_string |
drupal/ |
Replaces placeholders with sanitized values in a string. | 281 | 1 |
| format_xml_elements |
drupal/ |
Formats XML elements. | 7 | |
| form_builder |
drupal/ |
Builds and processes all elements in the structured form array. | 2 | |
| form_clear_error |
drupal/ |
Clears all errors against all form elements made by form_set_error(). | 3 | |
| form_error |
drupal/ |
Flags an element as having an error. | 43 | |
| form_execute_handlers |
drupal/ |
Executes custom validation and submission handlers for a given form. | 4 | |
| form_get_cache |
drupal/ |
Fetches a form from the cache. | 2 | |
| form_get_error |
drupal/ |
Returns the error message filed against the given form element. | 1 | |
| form_get_errors |
drupal/ |
Returns an associative array of all errors. | 15 | |
| form_get_options |
drupal/ |
Returns the indexes of a select element's options matching a given key. | ||
| form_label_test_form |
drupal/ |
A form for testing form labels and required marks. | 1 | |
| form_load_include |
drupal/ |
Ensures an include file is loaded whenever the form is processed. | 4 | |
| form_options_flatten |
drupal/ |
Allows PHP array processing of multiple select options with the same value. | 2 | |
| form_pre_render_conditional_form_element |
drupal/ |
Adds form element theming to an element if its title or description is set. | 1 | |
| form_pre_render_details |
drupal/ |
Adds members of this group as actual elements for rendering. | 1 | |
| form_process_actions |
drupal/ |
Processes a form actions container element. | 1 | |
| form_process_autocomplete |
drupal/ |
Adds autocomplete functionality to elements with a valid #autocomplete_path. | 1 | |
| form_process_button |
drupal/ |
Processes a form button element. | 1 | |
| form_process_checkbox |
drupal/ |
Sets the #checked property of a checkbox element. | 1 | |
| form_process_checkboxes |
drupal/ |
Processes a checkboxes form element. | 1 | 1 |
| form_process_container |
drupal/ |
Processes a container element. | 1 | |
| form_process_date |
drupal/ |
Expands a date element into year, month, and day select elements. | 1 | |
| form_process_details |
drupal/ |
Arranges details into groups. | 1 | |
| form_process_machine_name |
drupal/ |
Processes a machine-readable name form element. | 1 | |
| form_process_password_confirm |
drupal/ |
Expand a password_confirm field into two text boxes. | 1 | |
| form_process_pattern |
drupal/ |
#process callback for #pattern form element property. | 1 | |
| form_process_radios |
drupal/ |
Expands a radios element into individual radio elements. | 1 | 1 |
| form_process_select |
drupal/ |
Processes a select list form element. | 2 | |
| form_process_tableselect |
drupal/ |
Creates checkbox or radio elements to populate a tableselect table. | 1 | |
| form_process_vertical_tabs |
drupal/ |
Creates a group formatted as vertical tabs. | 1 | |
| form_process_weight |
drupal/ |
Expands a weight element into a select element. | 1 | |
| form_select_options |
drupal/ |
Converts a select form element's options array into HTML. | 1 | |
| form_set_cache |
drupal/ |
Stores a form in the cache. | 2 | |
| form_set_error |
drupal/ |
Files an error against a form element. | 88 | 1 |
| form_set_value |
drupal/ |
Changes submitted form values during form validation. | 27 | |
| form_state_defaults |
drupal/ |
Retrieves default values for the $form_state array. | 8 | |
| form_state_keys_no_cache |
drupal/ |
Returns an array of $form_state keys that shouldn't be cached. | 2 | |
| form_state_values_clean |
drupal/ |
Removes internal Form API elements and buttons from submitted form values. | 10 | |
| form_storage_test_form_continue_submit |
drupal/ |
Form submit handler to continue multi-step form. | 1 | |
| form_test_alter_form |
drupal/ |
Form builder for testing hook_form_alter() and hook_form_FORM_ID_alter(). | 2 | |
| form_test_button_class |
drupal/ |
Builds a simple form to test form button classes. | 1 | |
| form_test_checkboxes_radios |
drupal/ |
Form constructor to test expansion of #type checkboxes and radios. | 1 | |
| form_test_checkboxes_zero |
drupal/ |
1 | ||
| form_test_checkbox_type_juggling |
drupal/ |
1 | ||
| form_test_clicked_button |
drupal/ |
Form builder to test button click detection. | 1 | |
| form_test_clicked_button_submit |
drupal/ |
Form submit handler for the form_test_clicked_button() form. | ||
| form_test_clicked_button_validate |
drupal/ |
Form validation handler for the form_test_clicked_button() form. | ||
| form_test_color |
drupal/ |
Form constructor for testing #type 'color' elements. | 1 | |
| form_test_double_form |
drupal/ |
Menu callback returns two instances of the same form. | 1 |