Functions to enable output of HTML forms and form elements.
Drupal uses these functions to achieve consistency in its form presentation, while at the same time simplifying code and reducing the amount of HTML that must be explicitly generated by modules. See the reference at http://api.drupal.org/api/HEAD/file/developer/topics/forms_api_reference... and the quickstart guide at http://api.drupal.org/api/HEAD/file/developer/topics/forms_api.html
Functions & methods
| Name | Description |
|---|---|
| checkboxes_value | Helper function to load value from default value for checkboxes |
| date_validate | Validates the FAPI date type to stop dates like 30/Feb/2006 |
| drupal_get_form | Processes a form array and produces the HTML output of a form. If there is input in the $_POST['edit'] variable, this function will attempt to validate it, using drupal_validate_form(), and then submit the form using drupal_submit_form(). |
| drupal_submit_form | |
| drupal_validate_form | |
| element_child | Check if the key is a child. |
| element_children | Get keys of a form tree element that are not properties (i.e., do not begin with '#'). |
| element_properties | Get properties of a form tree element. Properties begin with '#'. |
| element_property | Check if the key is a property. |
| expand_checkboxes | |
| expand_date | Roll out a single date element. |
| expand_password_confirm | |
| expand_radios | Roll out a single radios element to a list of radios, using the options array as index. |
| form_builder | Adds some required properties to each form element, which are used internally in the form api. This function also automatically assigns the value property from the $edit array, provided the element doesn't already have an assigned value. |
| form_clean_id | Remove invalid characters from an HTML ID attribute string. |
| form_error | Flag an element as having an error. |
| 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_options_flatten | |
| form_render | Renders a HTML form given a form tree. Recursively iterates over each of the form elements, generating HTML code. This function is usually called from within a theme. To render a form from within a module, use drupal_get_form(). |
| form_select_options | |
| form_set_error | File an error against a form element. If the name of the element is edit[foo][bar] then you may pass either foo or foo][bar as $name foo will set an error for all its children. |
| form_set_value | Use this function to make changes to form values in the form validate phase, so they will be available in the submit phase in $form_values. |
| map_month | Helper function for usage with drupal_map_assoc to display month names. |
| password_confirm_validate | Validate password_confirm element. |
| theme_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_hidden | Format a hidden form field. |
| theme_item | Format a form item. |
| theme_markup | |
| theme_password | Format a password field. * |
| theme_password_confirm | Format a password_confirm item. |
| 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_textarea | Format a textarea. |
| theme_textfield | Format a textfield. |
| theme_token | |
| theme_weight | Format a weight selection menu. |
| weight_value | If no default value is set for weight select boxes, use 0. |
| _element_info | Retrieve the default properties for the defined element type. |
| _form_set_class | Sets a form element's class attribute. |
| _form_set_value | Helper function for form_set_value(). |
| _form_sort | Function used by uasort in form_render() to sort form by weight. |
| _form_validate |
File
- includes/
form.inc, line 3