Form generation

drupal
1. drupal6
2. drupal7

Functions to enable the processing and display of HTML forms.

Drupal 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 drupal_get_form() function handles retrieving and processing an HTML form for modules automatically. For example:

<?php

// Display the user registration form.
$output = drupal_get_form('user_register');

?>

Forms can also be built and submitted programmatically without any user input using the drupal_form_submit() function.

For information on the format of the structured arrays used to define forms, and more detailed explanations of the Form API workflow, see the reference and the quickstart guide.

Funktionen & Methoden

Name	Beschreibung
date_validate	Validates the date type to stop dates like February 30, 2006.
drupal_build_form	Build and process a form based on a form id.
drupal_form_submit	Retrieves a form using a form_id, populates it with $form_state['values'], processes it, and returns any validation errors encountered. This function is the programmatic counterpart to drupal_get_form().
drupal_get_form	Wrapper for drupal_build_form() for use when $form_state is not needed.
drupal_prepare_form	Prepares a structured form array by adding required elements, executing any hook_form_alter functions, and optionally inserting a validation token to prevent tampering.
drupal_process_form	This function is the heart of form API. The form gets built, validated and in appropriate cases, submitted.
drupal_rebuild_form	Retrieves a form, caches it and processes it with an empty $_POST.
drupal_redirect_form	Redirect 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 from the $form_state using the validate functions defined in a structured form array.
form_ahah_callback	Menu callback for AHAH callbacks through the #ahah['callback'] FAPI property.
form_builder	Walk through the structured form array, adding any required properties to each element and mapping the incoming $_POST data to the proper elements. Also, execute any #process handlers attached to a specific element.
form_clean_id	Prepare an HTML ID attribute string for a form item.
form_error	Flag an element as having an error.
form_execute_handlers	A helper function used to execute custom validation and submission handlers for a given form. Button-specific handlers are checked first. If none exist, the function falls back to form-level handlers.
form_get_cache	Fetch a form from cache.
form_get_error	Return the error message filed against the form with the specified name.
form_get_errors	Return an associative array of all errors.
form_get_options	Traverses a select element's #option array looking for any values that hold the given key. Returns an array of indexes that match.
form_options_flatten
form_pre_render_conditional_form_element	Add form_element theming to an element if title or desription is set.
form_pre_render_fieldset	Adds members of this group as actual elements for rendering.
form_process_ahah	Add AHAH information about a form element to the page to communicate with javascript. If #ahah[path] is set on an element, this additional javascript is added to the page header to attach the AHAH behaviors. See ahah.js for more information.
form_process_checkboxes
form_process_date	Roll out a single date element.
form_process_fieldset	Adds fieldsets to the specified group or adds group members to this fieldset.
form_process_password_confirm	Expand a password_confirm field into two text boxes.
form_process_radios	Roll out a single radios element to a list of radios, using the options array as index.
form_process_tableselect	Create the correct amount of checkbox or radio elements to populate the table.
form_process_text_format	Add text format selector to text elements with the #text_format property.
form_process_vertical_tabs	Creates a group formatted as vertical tabs.
form_process_weight	Expand weight elements into selects.
form_select_options
form_set_cache	Store a form in the cache
form_set_error	File an error against a form element.
form_set_value	Change submitted form values during the form processing cycle.
form_state_defaults	Retrieve default values for the $form_state array.
form_type_checkboxes_value	Helper function to determine the value for a checkboxes form element.
form_type_checkbox_value	Helper function to determine the value for a checkbox form element.
form_type_image_button_value	Helper function to determine the value for an image button form element.
form_type_password_confirm_value	Helper function to determine the value for a password_confirm form element.
form_type_select_value	Helper function to determine the value for a select form element.
form_type_textfield_value	Helper function to determine the value for a textfield form element.
form_type_token_value	Helper function to determine the value for form's token value.
map_month	Helper function for usage with drupal_map_assoc to display month names.
password_confirm_validate	Validate password_confirm element.
theme_button	Theme a form button.
theme_checkbox	Format a checkbox.
theme_checkboxes	Format a set of checkboxes.
theme_date	Format a date selection element.
theme_fieldset	Format a group of form items.
theme_file	Format a file upload field.
theme_form	Format a form.
theme_form_element	Return a themed form element.
theme_hidden	Format a hidden form field.
theme_image_button	Theme a form image button.
theme_markup
theme_password	Format a password field.
theme_radio	Format a radio button.
theme_radios	Format a set of radio buttons.
theme_select	Format a dropdown menu or scrolling selection box.
theme_submit	Theme a form submit button.
theme_tableselect	Format a table with radio buttons or checkboxes.
theme_textarea	Format a textarea.
theme_textfield	Format a textfield.
theme_text_format_wrapper	Return a themed text format form element.
theme_vertical_tabs	Makes the element's children fieldsets be vertical tabs.
weight_value	If no default value is set for weight select boxes, use 0.
_form_builder_handle_input_element	Populate the #value and #name properties of input elements so they can be processed and rendered.
_form_builder_ie_cleanup	In IE, if only one submit button is present, AND the enter key is used to submit the form, no form value is sent for it and our normal button detection code will never detect a match. We call this function after all other button-detection is complete…
_form_button_was_clicked	Helper function to handle the sometimes-convoluted logic of button click detection.
_form_set_class	Sets a form element's class attribute.
_form_set_value	Helper function for form_set_value().
_form_validate	Performs validation on form elements. First ensures required fields are completed, #maxlength is not exceeded, and selected options were in the list of options given to the user. Then calls user-defined validators.

includes/form.inc, line 23

DrupalAPI.de

API Seiten

drupal7 durchsuchen

Nützliche Verweise

Form generation

Funktionen & Methoden

Kommentare

Kommentar hinzufügen

Kommentar hinzufügen