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