Community Documentation

Form builder functions

  1. drupal
    1. 6 form.inc
    2. 7 form.inc
    3. 8 form.inc

Functions that build an abstract representation of a HTML form.

All modules should declare their form builder functions to be in this group and each builder function should reference its validate and submit functions using @see. Conversely, validate and submit functions should reference the form builder function using @see. For examples, of this see system_modules_uninstall() or user_pass(), the latter of which has the following in its doxygen documentation:

@ingroup forms @see user_pass_validate(). @see user_pass_submit().

End of "defgroup forms".

Functions & methods

NameDescription
aggregator_admin_settingsForm builder; Configure the aggregator system.
aggregator_categorize_itemsForm builder; build the page list form.
aggregator_form_categoryForm builder; Generate a form to add/edit/delete aggregator categories.
aggregator_form_feedForm builder; Generate a form to add/edit feed sources.
book_admin_editBuild the form to administrate the hierarchy of a single book.
book_admin_settingsBuilds and returns the book settings form.
book_outline_formBuild the form to handle all book outline operations via the outline tab.
book_remove_formMenu callback; builds a form to confirm removal of a node from the book.
comment_admin_overviewForm builder; Builds the comment overview form for the admin.
comment_confirm_deleteForm builder; Builds the confirmation form for deleting a single comment.
comment_controlsBuild a comment control form.
comment_editForm builder; generate a comment editing form.
comment_formGenerate the basic commenting form, for appending to a node or display on a separate page.
comment_form_add_previewForm builder; Generate and validate a comment preview form.
comment_multiple_delete_confirmList the selected comments and verify that the admin really wants to delete them.
comment_unpublish_by_keyword_action_formForm builder; Prepare a form for blacklisted keywords.
dblog_admin_settingsdblog module settings form.
dblog_filter_formReturn form for dblog administration filters.
filter_admin_configureBuild a form to change the settings for a format's filters.
filter_admin_deleteMenu callback; confirm deletion of a format.
filter_admin_format_formGenerate a filter format form.
filter_admin_orderBuild the form for ordering filters for a format.
filter_admin_overviewMenu callback; Displays a list of all input formats and which one is the default.
filter_formGenerates a selector for choosing a format in a form.
forum_form_containerReturns a form for adding a container to the forum vocabulary
forum_form_forumReturns a form for adding a forum to the forum vocabulary
openid_user_addForm builder; Add an OpenID identity.
openid_user_delete_formPresent a confirmation form to delete the specified OpenID identity from the system.
path_admin_filter_formReturn a form to filter URL aliases.
path_admin_formReturn a form for editing or creating an individual URL alias.
poll_cancel_formBuilds the cancel form for a poll.
poll_view_votingGenerates the voting form for a poll.
profile_admin_overviewForm builder to display a listing of all editable profile fields.
profile_field_formMenu callback: Generate a form to add/edit a user profile field.
search_admin_settingsMenu callback; displays the search module settings page.
search_boxForm builder; Output a search form for the search block and the theme's search box.
statistics_access_logging_settingsForm builder; Configure access logging.
system_actions_delete_formCreate the form for confirmation of deleting an action.
system_actions_manage_formDefine the form for the actions overview page.
system_admin_theme_settingsForm builder; This function allows selection of the theme to show in administration sections.
system_clean_url_settingsForm builder; Configure Clean URL settings.
system_clear_cache_submitSubmit callback; clear system caches.
system_date_time_settingsForm builder; Configure the site date and time settings.
system_error_reporting_settingsForm builder; Configure error reporting settings.
system_file_system_settingsForm builder; Configure the site file handling.
system_image_toolkit_settingsForm builder; Configure site image toolkit usage.
system_modulesMenu callback; provides module enable/disable interface.
system_modules_confirm_formDisplay confirmation form for dependencies.
system_modules_disableForm process callback function to disable check boxes.
system_modules_uninstallBuilds a form of currently disabled modules.
system_modules_uninstall_confirm_formConfirm uninstall of selected modules.
system_performance_settingsForm builder; Configure site performance settings.
system_rss_feeds_settingsForm builder; Configure how the site handles RSS feeds.
system_settings_formAdd default buttons to a form and set its prefix.
system_site_information_settingsForm builder; The general site information form.
system_site_maintenance_settingsForm builder; Configure the site's maintenance status.
system_themes_formMenu callback; displays a listing of all themes.
system_theme_settingsForm builder; display theme configuration for entire site and individual themes.
taxonomy_form_termForm function for the term edit form.
taxonomy_form_vocabularyDisplay form for adding and editing vocabularies.
taxonomy_overview_termsForm builder for the taxonomy terms overview.
taxonomy_overview_vocabulariesForm builder to list and manage vocabularies.
taxonomy_term_confirm_deleteForm builder for the term delete form.
taxonomy_term_confirm_parentsForm builder for the confirmation of multiple term parents.
taxonomy_vocabulary_confirm_deleteForm builder for the vocabulary delete confirmation form.
taxonomy_vocabulary_confirm_reset_alphabeticalForm builder to confirm reseting a vocabulary to alphabetical order.
throttle_admin_settingsForm builder; Configure the throttle system.
trigger_unassignConfirm removal of an assigned action.
user_admin_access_delete_confirmMenu callback: delete an access rule
user_admin_access_formForm builder; Configure access rules.
user_admin_accountForm builder; User administration page.
user_admin_permMenu callback: administer permissions.
user_admin_roleMenu callback: administer roles.
user_admin_settingsForm builder; Configure user settings for this site.
user_confirm_deleteForm builder; confirm form for user deletion.
user_editForm builder; Present the form to edit a given user or profile category.
user_filter_formForm builder; Return form for user administration filters.
user_loginForm builder; the main user login form.
user_passForm builder; Request a password reset.
user_profile_formForm builder; edit a user account or one of their profile categories.
user_registerForm builder; The user registration form.

File

includes/form.inc, line 3

Login or register to post comments