Drupal的组成部分 4.表单生成

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, processing, and displaying a rendered 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_execute() 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.

函数

名称	位置	描述
date_validate	includes/form.inc	Validates the date type to stop dates like February 30, 2006.
drupal_execute	includes/form.inc	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 todrupal_get_form().
drupal_get_form	includes/form.inc	Retrieves a form from a constructor function, or from the cache if the form was built in a previous page-load. The form is then passed on for processing, after and rendered for display if necessary.
drupal_prepare_form	includes/form.inc	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	includes/form.inc	This function is the heart of form API. The form gets built, validated and in appropriate cases, submitted.
drupal_rebuild_form	includes/form.inc	Retrieves a form, caches it and processes it with an empty $_POST.
drupal_redirect_form	includes/form.inc	Redirect the user to a URL after a form has been processed.
drupal_render_form	includes/form.inc	Renders a structured form array into themed HTML.
drupal_retrieve_form	includes/form.inc	Retrieves the structured array that defines a given form.
drupal_validate_form	includes/form.inc	Validates user-submitted form data from the $form_state using the validate functions defined in a structured form array.
form_builder	includes/form.inc	Walk through the structured form array, adding any required properties to each element and mapping the incoming $_POST data to the proper elements.
form_clean_id	includes/form.inc	Prepare an HTML ID attribute string for a form item.
form_error	includes/form.inc	Flag an element as having an error.
form_execute_handlers	includes/form.inc	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	includes/form.inc	Fetch a form from cache.
form_get_error	includes/form.inc	Return the error message filed against the form with the specified name.
form_get_errors	includes/form.inc	Return an associative array of all errors.
form_get_options	includes/form.inc	Traverses a select element's #option array looking for any values that hold the given key. Returns an array of indexes that match.
form_process_ahah	includes/form.inc	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_date	includes/form.inc	Roll out a single date element.
form_process_input_format	includes/form.inc	Add input format selector to text elements with the #input_format property.
form_process_password_confirm	includes/form.inc	Expand a password_confirm field into two text boxes.
form_process_radios	includes/form.inc	Roll out a single radios element to a list of radios, using the options array as index.
form_process_weight	includes/form.inc	Expand weight elements into selects.
form_set_cache	includes/form.inc	Store a form in the cache
form_set_error	includes/form.inc	File an error against a form element.
form_set_value	includes/form.inc	Change submitted form values during the form processing cycle.
form_type_checkboxes_value	includes/form.inc	Helper function to determine the value for a checkboxes form element.
form_type_checkbox_value	includes/form.inc	Helper function to determine the value for a checkbox form element.
form_type_image_button_value	includes/form.inc	Helper function to determine the value for an image button form element.
form_type_password_confirm_value	includes/form.inc	Helper function to determine the value for a password_confirm form element.
form_type_select_value	includes/form.inc	Helper function to determine the value for a select form element.
form_type_textfield_value	includes/form.inc	Helper function to determine the value for a textfield form element.
form_type_token_value	includes/form.inc	Helper function to determine the value for form's token value.
map_month	includes/form.inc	Helper function for usage with drupal_map_assoc to display month names.
password_confirm_validate	includes/form.inc	Validate password_confirm element.
theme_button	includes/form.inc	Theme a form button.
theme_checkbox	includes/form.inc	Format a checkbox.
theme_checkboxes	includes/form.inc	Format a set of checkboxes.
theme_date	includes/form.inc	Format a date selection element.
theme_fieldset	includes/form.inc	Format a group of form items.
theme_file	includes/form.inc	Format a file upload field.
theme_form	includes/form.inc	Format a form.
theme_form_element	includes/form.inc	Return a themed form element.
theme_hidden	includes/form.inc	Format a hidden form field.
theme_image_button	includes/form.inc	Theme a form image button.
theme_item	includes/form.inc	Format a form item.
theme_password	includes/form.inc	Format a password field.
theme_password_confirm	includes/form.inc	Format a password_confirm item.
theme_radio	includes/form.inc	Format a radio button.
theme_radios	includes/form.inc	Format a set of radio buttons.
theme_select	includes/form.inc	Format a dropdown menu or scrolling selection box.
theme_submit	includes/form.inc	Theme a form submit button.
theme_textarea	includes/form.inc	Format a textarea.
theme_textfield	includes/form.inc	Format a textfield.
theme_token	includes/form.inc	Format a form token.
weight_value	includes/form.inc	If no default value is set for weight select boxes, use 0.
_element_info	includes/form.inc	Retrieve the default properties for the defined element type.
_form_builder_handle_input_element	includes/form.inc	Populate the #value and #name properties of input elements so they can be processed and rendered. Also, execute any #process handlers attached to a specific element.
_form_builder_ie_cleanup	includes/form.inc	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	includes/form.inc	Helper function to handle the sometimes-convoluted logic of button click detection.
_form_set_class	includes/form.inc	Sets a form element's class attribute.
_form_set_value	includes/form.inc	Helper function for form_set_value().
_form_validate	includes/form.inc	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.