1. 1.12.x includes/form.inc form_api
  2. 1.10.x includes/form.inc form_api
  3. 1.11.x includes/form.inc form_api
  4. 1.7.x includes/form.inc form_api
  5. 1.8.x includes/form.inc form_api
  6. 1.9.x includes/form.inc form_api

Functions to enable the processing and display of HTML forms.

Backdrop 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 primary function used with forms is backdrop_get_form(), which is used for forms presented interactively to a user. Forms can also be built and submitted programmatically without any user input using the backdrop_form_submit() function.

backdrop_get_form() handles retrieving, processing, and displaying a rendered HTML form for modules automatically.

Here is an example of how to use backdrop_get_form() and a form builder function:

$form = backdrop_get_form('my_module_example_form');
...
function my_module_example_form($form, &$form_state) {
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Submit'),
  );
  return $form;
}
function my_module_example_form_validate($form, &$form_state) {
  // Validation logic.
}
function my_module_example_form_submit($form, &$form_state) {
  // Submission logic.
}

Or with any number of additional arguments:

$extra = "extra";
$form = backdrop_get_form('my_module_example_form', $extra);
...
function my_module_example_form($form, &$form_state, $extra) {
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => $extra,
  );
  return $form;
}

The $form argument to form-related functions is a structured array containing the elements and properties of the form. For information on the array components and format, and more detailed explanations of the Form API workflow, see the Form API reference and the Form API documentation section. In addition, there is a set of Form API tutorials in the Form Example Tutorial which provide basics all the way up through multistep forms.

In the form builder, validation, submission, and other form functions, $form_state is the primary influence on the processing of the form and is passed by reference to most functions, so they use it to communicate with the form system and each other.

See backdrop_build_form() for documentation of $form_state keys.

File

includes/form.inc, line 26
Functions for form and batch generation and processing.

Functions

Namesort descending Location Description
backdrop_build_form includes/form.inc Builds and processes a form for a given form ID.
backdrop_form_submit includes/form.inc Retrieves, populates, and processes a form.
backdrop_get_form includes/form.inc Returns a renderable form array for a given form ID.
_backdrop_invalid_token_set_form_error includes/form.inc Helper function to call form_set_error() if there is a token error.
backdrop_prepare_form includes/form.inc Prepares a structured form array.
backdrop_process_form includes/form.inc Processes a form submission.
backdrop_rebuild_form includes/form.inc Constructs a new $form from the information in $form_state.
backdrop_redirect_form includes/form.inc Redirects the user to a URL after a form has been processed.
backdrop_retrieve_form includes/form.inc Retrieves the structured array that defines a given form.
backdrop_validate_form includes/form.inc Validates user-submitted form data in the $form_state array.
date_validate includes/form.inc Validates the date type to prevent invalid dates (e.g., February 30, 2006).
form_builder includes/form.inc Builds and processes all elements in the structured form array.
_form_builder_handle_input_element includes/form.inc Adds the #name and #value properties of an input element before rendering.
_form_button_was_clicked includes/form.inc Determines if a given button triggered the form submission.
form_clear_error includes/form.inc Clears all errors against all form elements made by form_set_error().
_form_element_triggered_scripted_submission includes/form.inc Detects if an element triggered the form submission via Ajax.
form_error includes/form.inc Flags an element as having an error.
form_execute_handlers includes/form.inc Executes custom validation and submission handlers for a given form.
form_get_cache includes/form.inc Fetches a form from the cache.
form_get_error includes/form.inc Returns the error message filed against the given form element.
form_get_errors includes/form.inc Returns an associative array of all errors.
form_get_options includes/form.inc Returns the indexes of a select element's options matching a given key.
form_load_include includes/form.inc Ensures an include file is loaded whenever the form is processed.
_form_options_flatten includes/form.inc Iterates over an array and returns a flat array with duplicate keys removed.
form_options_flatten includes/form.inc Allows PHP array processing of multiple select options with the same value.
form_pre_render_conditional_form_element includes/form.inc Adds form element theming to an element if its title or description is set.
form_pre_render_fieldset includes/form.inc Adds members of this group as actual elements for rendering.
form_process_actions includes/form.inc Processes a form actions container element.
form_process_autocomplete includes/form.inc Process function to prepare autocomplete data.
form_process_checkbox includes/form.inc Sets the #checked property of a checkbox element.
form_process_checkboxes includes/form.inc Processes a checkboxes form element.
form_process_container includes/form.inc Processes a container element.
form_process_date includes/form.inc Expands a date element into year, month, and day select elements.
form_process_fieldset includes/form.inc Arranges fieldsets into groups.
form_process_machine_name includes/form.inc Processes a machine-readable name form element.
form_process_password_confirm includes/form.inc Expand a password_confirm field into two text boxes.
form_process_radios includes/form.inc Expands a radios element into individual radio elements.
form_process_select includes/form.inc Processes a select list form element.
form_process_tableselect includes/form.inc Creates checkbox or radio elements to populate a tableselect table.
form_process_vertical_tabs includes/form.inc Creates a group formatted as vertical tabs.
form_process_weight includes/form.inc Expands a weight element into a select element.
form_select_options includes/form.inc Converts an array of options into HTML, for use in select list form elements.
form_set_cache includes/form.inc Stores a form in the cache.
_form_set_class includes/form.inc Sets a form element's class attribute.
form_set_error includes/form.inc Files an error against a form element.
form_set_value includes/form.inc Changes submitted form values during form validation.
form_state_defaults includes/form.inc Retrieves default values for the $form_state array.
form_state_keys_no_cache includes/form.inc Returns an array of $form_state keys that shouldn't be cached.
form_state_values_clean includes/form.inc Removes internal Form API elements and buttons from submitted form values.
form_type_checkboxes_value includes/form.inc Determines the value for a checkboxes form element.
form_type_checkbox_value includes/form.inc Determines the value for a checkbox form element.
form_type_image_button_value includes/form.inc Determines the value for an image button form element.
form_type_password_confirm_value includes/form.inc Determines the value for a password_confirm form element.
form_type_radios_value includes/form.inc Form value callback: Determines the value for a #type radios form element.
form_type_select_value includes/form.inc Determines the value for a select form element.
form_type_tableselect_value includes/form.inc Determines the value for a tableselect form element.
form_type_textfield_value includes/form.inc Determines the value for a textfield form element.
form_type_token_value includes/form.inc Determines the value for form's token value.
_form_validate includes/form.inc Performs validation on form elements.
form_validate_color includes/form.inc Form element validation handler for #type 'color'.
form_validate_email includes/form.inc Form element validation handler for #type 'email'.
form_validate_machine_name includes/form.inc Form element validation handler for machine_name elements.
form_validate_number includes/form.inc Form element validation handler for #type 'number'.
form_validate_url includes/form.inc Form element validation handler for #type 'url'.
map_month includes/form.inc Renders a month name for display.
password_confirm_validate includes/form.inc Validates a password_confirm element.
theme_button includes/form.inc Returns HTML for a button form element.
theme_checkbox includes/form.inc Returns HTML for a checkbox form element.
theme_color includes/form.inc Returns HTML for a color form element.
theme_container includes/form.inc Returns HTML to wrap child elements in a container.
theme_date includes/form.inc Returns HTML for a date selection form element.
theme_email includes/form.inc Returns HTML for an email form element.
theme_fieldset includes/form.inc Returns HTML for a fieldset form element and its children.
theme_file includes/form.inc Returns HTML for a file upload form element.
theme_form includes/form.inc Returns HTML for a form.
theme_form_element includes/form.inc Returns HTML for a form element.
theme_form_element_label includes/form.inc Returns HTML for a form element label and required marker.
theme_form_required_marker includes/form.inc Returns HTML for a marker for required form elements.
theme_hidden includes/form.inc Returns HTML for a hidden form element.
theme_image_button includes/form.inc Returns HTML for an image button form element.
theme_number includes/form.inc Returns HTML for a number form element.
theme_password includes/form.inc Returns HTML for a password form element.
theme_radio includes/form.inc Returns HTML for a radio button form element.
theme_range includes/form.inc Returns HTML for a range form element.
theme_search includes/form.inc Returns HTML for a search form element.
theme_select includes/form.inc Returns HTML for a select form element.
theme_submit includes/form.inc Returns HTML for a submit button form element.
theme_tableselect includes/form.inc Returns HTML for a table with radio buttons or checkboxes.
theme_tel includes/form.inc Returns HTML for a tel form element.
theme_textarea includes/form.inc Returns HTML for a textarea form element.
theme_textfield includes/form.inc Returns HTML for a textfield form element.
theme_url includes/form.inc Returns HTML for a URL form element.
theme_vertical_tabs includes/form.inc Returns HTML for an element's children fieldsets as vertical tabs.
weight_value includes/form.inc Sets the value for a weight element, with zero as a default.