Form builder functions

  1. 7.x drupal/includes/form.inc forms
  2. 6.x drupal/includes/form.inc forms

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:

Functions

Namesort descending Location Description
aggregator_admin_form drupal/modules/aggregator/aggregator.admin.inc Form constructor for the aggregator system settings.
aggregator_categorize_items drupal/modules/aggregator/aggregator.pages.inc Form constructor to build the page list form.
aggregator_form_category drupal/modules/aggregator/aggregator.admin.inc Form constructor to add/edit/delete aggregator categories.
aggregator_form_feed drupal/modules/aggregator/aggregator.admin.inc Form constructor for adding and editing feed sources.
aggregator_form_opml drupal/modules/aggregator/aggregator.admin.inc Form constructor for importing feeds from OPML.
authorize_filetransfer_form drupal/includes/authorize.inc Form constructor for the file transfer authorization form.
block_add_block_form drupal/modules/block/block.admin.inc Form constructor for the add block form.
block_admin_configure drupal/modules/block/block.admin.inc Form constructor for the block configuration form.
block_admin_display_form drupal/modules/block/block.admin.inc Form constructor for the main block administration form.
block_custom_block_form drupal/modules/block/block.module Form constructor for the custom block form.
book_admin_edit drupal/modules/book/book.admin.inc Form constructor for administering a single book's hierarchy.
book_admin_settings drupal/modules/book/book.admin.inc Form constructor for the book settings form.
book_outline_form drupal/modules/book/book.pages.inc Form constructor for the book outline form.
book_remove_form drupal/modules/book/book.pages.inc Form constructor to confirm removal of a node from a book.
color_scheme_form drupal/modules/color/color.module Form constructor for the color configuration form for a particular theme.
comment_admin_overview drupal/modules/comment/comment.admin.inc Form builder for the comment overview administration form.
comment_confirm_delete drupal/modules/comment/comment.admin.inc Form builder; Builds the confirmation form for deleting a single comment.
comment_form drupal/modules/comment/comment.module Generate the basic commenting form, for appending to a node or display on a separate page.
comment_multiple_delete_confirm drupal/modules/comment/comment.admin.inc List the selected comments and verify that the admin wants to delete them.
comment_unpublish_by_keyword_action_form drupal/modules/comment/comment.module Form builder; Prepare a form for blacklisted keywords.
contact_category_edit_form drupal/modules/contact/contact.admin.inc Form constructor for the category edit form.
contact_personal_form drupal/modules/contact/contact.pages.inc Form constructor for the personal contact form.
contact_site_form drupal/modules/contact/contact.pages.inc Form constructor for the site-wide contact form.
dblog_clear_log_form drupal/modules/dblog/dblog.admin.inc Form constructor for the form that clears out the log.
dblog_filter_form drupal/modules/dblog/dblog.admin.inc Form constructor for the database logging filter form.
field_ui_display_overview_form drupal/modules/field_ui/field_ui.admin.inc Form constructor for the field display settings for a given view mode.
field_ui_field_delete_form drupal/modules/field_ui/field_ui.admin.inc Form constructor for removing a field instance from a bundle.
field_ui_field_edit_form drupal/modules/field_ui/field_ui.admin.inc Form constructor for the field instance settings form.
field_ui_field_overview_form drupal/modules/field_ui/field_ui.admin.inc Form constructor for the 'Manage fields' form of a bundle.
field_ui_field_settings_form drupal/modules/field_ui/field_ui.admin.inc Form constructor for the field settings edit page.
field_ui_widget_type_form drupal/modules/field_ui/field_ui.admin.inc Form constructor for the widget selection form.
file_module_test_form drupal/modules/file/tests/file_module_test.module Form constructor for testing a 'managed_file' element.
filter_admin_disable drupal/modules/filter/filter.admin.inc Form constructor for the text format deletion confirmation form.
filter_admin_format_form drupal/modules/filter/filter.admin.inc Form constructor for the text format add/edit form.
filter_admin_overview drupal/modules/filter/filter.admin.inc Page callback: Form constructor for a form to list and reorder text formats.
forum_admin_settings drupal/modules/forum/forum.admin.inc Form constructor for the forum settings page.
forum_confirm_delete drupal/modules/forum/forum.admin.inc Form constructor for confirming deletion of a forum taxonomy term.
forum_form_container drupal/modules/forum/forum.admin.inc Form constructor for adding and editing forum containers.
forum_form_forum drupal/modules/forum/forum.admin.inc Form constructor for adding and editing a forum.
forum_overview drupal/modules/forum/forum.admin.inc Form constructor for the forum overview form.
image_effect_delete_form drupal/modules/image/image.admin.inc Form builder; Form for deleting an image effect.
image_effect_form drupal/modules/image/image.admin.inc Form builder; Form for adding and editing image effects.
image_style_add_form drupal/modules/image/image.admin.inc Form builder; Form for adding a new image style.
image_style_delete_form drupal/modules/image/image.admin.inc Form builder; Form for deleting an image style.
image_style_form drupal/modules/image/image.admin.inc Form builder; Edit an image style name and effects order.
install_configure_form drupal/includes/install.core.inc Form constructor for a form to configure the new site.
install_select_locale_form drupal/includes/install.core.inc Form constructor for the language selection form.
install_select_profile_form drupal/includes/install.core.inc Form constructor for the profile selection form.
install_settings_form drupal/includes/install.core.inc Form constructor for a form to configure and rewrite settings.php.
locale_language_selector_form drupal/modules/locale/locale.module Form builder callback to display language selection widget.
locale_translation_filter_form drupal/modules/locale/locale.admin.inc Return form for locale translation filters.
node_admin_content drupal/modules/node/node.admin.inc Page callback: Form constructor for the content administration form.
node_admin_nodes drupal/modules/node/node.admin.inc Form builder: Builds the node administration overview.
node_assign_owner_action_form drupal/modules/node/node.module Generates the settings form for node_assign_owner_action().
node_configure_rebuild_confirm drupal/modules/node/node.admin.inc Menu callback: confirm rebuilding of permissions.
node_filter_form drupal/modules/node/node.admin.inc Returns the node administration filters form array to node_admin_content().
node_form drupal/modules/node/node.pages.inc Form constructor for the node add/edit form.
node_multiple_delete_confirm drupal/modules/node/node.admin.inc Multiple node deletion confirmation form for node_admin_content().
node_revision_delete_confirm drupal/modules/node/node.pages.inc Form constructor for the revision deletion confirmation form.
node_revision_revert_confirm drupal/modules/node/node.pages.inc Asks for confirmation of the reversion to prevent against CSRF attacks.
node_type_delete_confirm drupal/modules/node/content_types.inc Menu callback; delete a single content type.
node_type_form drupal/modules/node/content_types.inc Form constructor for the node type editing form.
openid_user_add drupal/modules/openid/openid.pages.inc Form builder; Add an OpenID identity.
path_admin_filter_form drupal/modules/path/path.admin.inc Form constructor for the path admin overview filter form.
path_admin_form drupal/modules/path/path.admin.inc Form constructor for the path administration form.
poll_cancel_form drupal/modules/poll/poll.module Builds the cancel form for a poll.
poll_view_voting drupal/modules/poll/poll.module Generates the voting form for a poll.
profile_admin_overview drupal/modules/profile/profile.admin.inc Form builder to display a listing of all editable profile fields.
profile_field_form drupal/modules/profile/profile.admin.inc Menu callback: Generate a form to add/edit a user profile field.
search_admin_settings drupal/modules/search/search.admin.inc Menu callback: displays the search module settings page.
search_box drupal/modules/search/search.module Form builder; Output a search form for the search block's search box.
shortcut_link_add drupal/modules/shortcut/shortcut.admin.inc Form callback: builds the form for adding a new shortcut link.
shortcut_link_delete drupal/modules/shortcut/shortcut.admin.inc Form callback: builds the confirmation form for deleting a shortcut link.
shortcut_link_edit drupal/modules/shortcut/shortcut.admin.inc Form callback: builds the form for editing a shortcut link.
shortcut_set_add_form drupal/modules/shortcut/shortcut.admin.inc Form callback: builds the form for adding a shortcut set.
shortcut_set_customize drupal/modules/shortcut/shortcut.admin.inc Form callback: builds the form for customizing shortcut sets.
shortcut_set_delete_form drupal/modules/shortcut/shortcut.admin.inc Form callback: builds the confirmation form for deleting a shortcut set.
shortcut_set_edit_form drupal/modules/shortcut/shortcut.admin.inc Form callback: builds the form for editing the shortcut set name.
shortcut_set_switch drupal/modules/shortcut/shortcut.admin.inc Form callback: builds the form for switching shortcut sets.
simpletest_settings_form drupal/modules/simpletest/simpletest.pages.inc Provides settings form for SimpleTest variables.
statistics_settings_form drupal/modules/statistics/statistics.admin.inc Form constructor for the statistics administration form.
system_actions_delete_form drupal/modules/system/system.admin.inc Create the form for confirmation of deleting an action.
system_actions_manage_form drupal/modules/system/system.admin.inc Define the form for the actions overview page.
system_add_date_format_type_form drupal/modules/system/system.admin.inc Add new date type.
system_clean_url_settings drupal/modules/system/system.admin.inc Form builder; Configure clean URL settings.
system_clear_cache_submit drupal/modules/system/system.admin.inc Submit callback; clear system caches.
system_clear_page_cache_submit drupal/modules/system/system.admin.inc Submit callback; clear the page cache.
system_cron_settings drupal/modules/system/system.admin.inc Form builder; Cron form.
system_date_time_settings drupal/modules/system/system.admin.inc Form builder; Configure the site date and time settings.
system_file_system_settings drupal/modules/system/system.admin.inc Form builder; Configure the site file handling.
system_image_toolkit_settings drupal/modules/system/system.admin.inc Form builder; Configure site image toolkit usage.
system_ip_blocking_form drupal/modules/system/system.admin.inc Define the form for blocking IP addresses.
system_logging_settings drupal/modules/system/system.admin.inc Form builder; Configure error reporting settings.
system_modules drupal/modules/system/system.admin.inc Menu callback; provides module enable/disable interface.
system_modules_confirm_form drupal/modules/system/system.admin.inc Display confirmation form for required modules.
system_modules_uninstall drupal/modules/system/system.admin.inc Builds a form of currently disabled modules.
system_modules_uninstall_confirm_form drupal/modules/system/system.admin.inc Confirm uninstall of selected modules.
system_performance_settings drupal/modules/system/system.admin.inc Form builder; Configure site performance settings.
system_regional_settings drupal/modules/system/system.admin.inc Form builder; Configure the site regional settings.
system_rss_feeds_settings drupal/modules/system/system.admin.inc Form builder; Configure how the site handles RSS feeds.
system_run_cron_submit drupal/modules/system/system.admin.inc Submit callback; run cron.
system_settings_form drupal/modules/system/system.module Sets up a form to save information automatically.
system_site_information_settings drupal/modules/system/system.admin.inc Form builder; The general site information form.
system_site_maintenance_mode drupal/modules/system/system.admin.inc Form builder; Configure the site's maintenance status.
system_themes_admin_form drupal/modules/system/system.admin.inc Form to select the administration theme.
system_theme_settings drupal/modules/system/system.admin.inc Form builder; display theme configuration for entire site and individual themes.
taxonomy_form_term drupal/modules/taxonomy/taxonomy.admin.inc Form function for the term edit form.
taxonomy_form_vocabulary drupal/modules/taxonomy/taxonomy.admin.inc Form builder for the vocabulary editing form.
taxonomy_overview_terms drupal/modules/taxonomy/taxonomy.admin.inc Form builder for the taxonomy terms overview.
taxonomy_overview_vocabularies drupal/modules/taxonomy/taxonomy.admin.inc Form builder to list and manage vocabularies.
taxonomy_term_confirm_delete drupal/modules/taxonomy/taxonomy.admin.inc Form builder for the term delete form.
taxonomy_vocabulary_confirm_delete drupal/modules/taxonomy/taxonomy.admin.inc Form builder for the vocabulary delete confirmation form.
taxonomy_vocabulary_confirm_reset_alphabetical drupal/modules/taxonomy/taxonomy.admin.inc Form builder to confirm resetting a vocabulary to alphabetical order.
trigger_assign_form drupal/modules/trigger/trigger.admin.inc Returns the form for assigning an action to a trigger.
trigger_unassign drupal/modules/trigger/trigger.admin.inc Form constructor for confirmation page for removal of an assigned action.
update_manager_install_form drupal/modules/update/update.manager.inc Form constructor for the install form of the Update Manager module.
update_manager_update_form drupal/modules/update/update.manager.inc Form constructor for the update form of the Update Manager module.
update_manager_update_ready_form drupal/modules/update/update.manager.inc Form constructor for the update ready form.
update_settings drupal/modules/update/update.settings.inc Form constructor for the update settings form.
user_admin_account drupal/modules/user/user.admin.inc Form builder; User administration page.
user_admin_permissions drupal/modules/user/user.admin.inc Menu callback: administer permissions.
user_admin_role drupal/modules/user/user.admin.inc Form to configure a single role.
user_admin_roles drupal/modules/user/user.admin.inc Form to re-order roles or add a new one.
user_admin_settings drupal/modules/user/user.admin.inc Form builder; Configure user settings for this site.
user_cancel_confirm_form drupal/modules/user/user.pages.inc Form builder; confirm form for cancelling user account.
user_filter_form drupal/modules/user/user.admin.inc Form builder; Return form for user administration filters.
user_login drupal/modules/user/user.module Form builder; the main user login form.
user_pass drupal/modules/user/user.pages.inc Form builder; Request a password reset.
user_profile_form drupal/modules/user/user.pages.inc Form builder; edit a user account or one of their profile categories.
user_register_form drupal/modules/user/user.module Form builder; the user registration form.
_install_configure_form drupal/includes/install.core.inc Form constructor for a site configuration form.

File

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