Form builder functions

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()

File

drupal/core/includes/form.inc, line 18

Functions for form and batch generation and processing.

Functions

Name	Location	Description
aggregator_categorize_items	drupal/core/modules/aggregator/aggregator.pages.inc	Form constructor to build the page list form.
aggregator_form_category	drupal/core/modules/aggregator/aggregator.admin.inc	Form constructor to add/edit/delete aggregator categories.
aggregator_page_category	drupal/core/modules/aggregator/aggregator.pages.inc	Form constructor to list items aggregated in a category.
aggregator_page_category_form	drupal/core/modules/aggregator/aggregator.pages.inc	Form constructor to list items aggregated in a category.
aggregator_page_source_form	drupal/core/modules/aggregator/aggregator.pages.inc	Form constructor to show all items captured from a feed.
authorize_filetransfer_form	drupal/core/includes/authorize.inc	Form constructor for the file transfer authorization form.
book_admin_edit	drupal/core/modules/book/book.admin.inc	Form constructor for administering a single book's hierarchy.
book_outline_form	drupal/core/modules/book/book.pages.inc	Form constructor for the book outline form.
book_remove_form	drupal/core/modules/book/book.pages.inc	Form constructor to confirm removal of a node from a book.
color_scheme_form	drupal/core/modules/color/color.module	Form constructor for the color configuration form for a particular theme.
comment_admin_overview	drupal/core/modules/comment/comment.admin.inc	Form constructor for the comment overview administration form.
comment_confirm_delete	drupal/core/modules/comment/comment.admin.inc	Form constructor for the confirmation form for comment deletion.
comment_multiple_delete_confirm	drupal/core/modules/comment/comment.admin.inc	Form constructor for the confirmation form for bulk comment deletion.
contact_personal_page	drupal/core/modules/contact/contact.pages.inc	Page callback: Form constructor for the personal contact form.
contact_site_page	drupal/core/modules/contact/contact.pages.inc	Page callback: Presents the site-wide contact form.
custom_block_delete_form	drupal/core/modules/block/custom_block/custom_block.pages.inc	Page callback: Form constructor for the custom block deletion form.
custom_block_type_delete_form	drupal/core/modules/block/custom_block/custom_block.admin.inc	Page callback: Form constructor for the custom block type deletion form.
dblog_clear_log_form	drupal/core/modules/dblog/dblog.admin.inc	Form constructor for the form that clears out the log.
dblog_filter_form	drupal/core/modules/dblog/dblog.admin.inc	Form constructor for the database logging filter form.
edit_field_form	drupal/core/modules/edit/edit.module	Form constructor for the field editing form.
file_module_test_form	drupal/core/modules/file/tests/file_module_test.module	Form constructor for testing a 'managed_file' element.
filter_admin_format_form	drupal/core/modules/filter/filter.admin.inc	Form constructor for the text format add/edit form.
filter_admin_overview	drupal/core/modules/filter/filter.admin.inc	Page callback: Form constructor for a form to list and reorder text formats.
form_test_color	drupal/core/modules/system/tests/modules/form_test/form_test.module	Form constructor for testing #type 'color' elements.
form_test_email	drupal/core/modules/system/tests/modules/form_test/form_test.module	Form constructor for testing #type 'email' elements.
form_test_range	drupal/core/modules/system/tests/modules/form_test/form_test.module	Form constructor for testing #type 'range' elements.
form_test_range_invalid	drupal/core/modules/system/tests/modules/form_test/form_test.module	Form constructor for testing invalid #type 'range' elements.
form_test_url	drupal/core/modules/system/tests/modules/form_test/form_test.module	Form constructor for testing #type 'url' elements.
forum_form_container	drupal/core/modules/forum/forum.admin.inc	Form constructor for adding and editing forum containers.
forum_form_forum	drupal/core/modules/forum/forum.admin.inc	Form constructor for adding and editing a forum.
forum_overview	drupal/core/modules/forum/forum.admin.inc	Form constructor for the forum overview form.
image_effect_form	drupal/core/modules/image/image.admin.inc	Form builder; Form for adding and editing image effects.
image_style_add_form	drupal/core/modules/image/image.admin.inc	Form builder; Form for adding a new image style.
image_style_form	drupal/core/modules/image/image.admin.inc	Form builder; Edit an image style name and effects order.
install_configure_form	drupal/core/includes/install.core.inc	Form constructor for a form to configure the new site.
install_select_language_form	drupal/core/includes/install.core.inc	Form constructor for the language selection form.
install_select_profile_form	drupal/core/includes/install.core.inc	Form constructor for the profile selection form.
install_settings_form	drupal/core/includes/install.core.inc	Form constructor for a form to configure and rewrite settings.php.
language_content_settings_form	drupal/core/modules/language/language.admin.inc	Form constructor for the content language settings form.
locale_translate_edit_form	drupal/core/modules/locale/locale.pages.inc	Form constructor for the string editing form.
locale_translate_export_form	drupal/core/modules/locale/locale.bulk.inc	Form constructor for the Gettext translation files export form.
locale_translate_filter_form	drupal/core/modules/locale/locale.pages.inc	Return form for locale translation filters.
locale_translate_import_form	drupal/core/modules/locale/locale.bulk.inc	Form constructor for the translation import screen.
node_admin_nodes	drupal/core/modules/node/node.admin.inc	Returns the admin form object to node_admin_content().
node_configure_rebuild_confirm	drupal/core/modules/node/node.admin.inc	Page callback: Form constructor for the permission rebuild confirmation form.
node_revision_delete_confirm	drupal/core/modules/node/node.pages.inc	Page callback: Form constructor for the revision deletion confirmation form.
node_revision_revert_confirm	drupal/core/modules/node/node.pages.inc	Page callback: Form constructor for the reversion confirmation form.
node_type_delete_confirm	drupal/core/modules/node/content_types.inc	Page callback: Form constructor for the content type delete form.
node_type_form	drupal/core/modules/node/content_types.inc	Form constructor for the node type editing form.
path_admin_filter_form	drupal/core/modules/path/path.admin.inc	Form constructor for the path admin overview filter form.
path_admin_form	drupal/core/modules/path/path.admin.inc	Form constructor for the path administration form.
search_box	drupal/core/modules/search/search.module	Form constructor for the search block's search box.
shortcut_link_add	drupal/core/modules/shortcut/shortcut.admin.inc	Form callback: builds the form for adding a new shortcut link.
shortcut_link_edit	drupal/core/modules/shortcut/shortcut.admin.inc	Form callback: builds the form for editing a shortcut link.
shortcut_set_customize	drupal/core/modules/shortcut/shortcut.admin.inc	Form callback: builds the form for customizing shortcut sets.
shortcut_set_switch	drupal/core/modules/shortcut/shortcut.admin.inc	Form callback: builds the form for switching shortcut sets.
system_config_form	drupal/core/modules/system/system.module	Adds default behavior to a configuration form.
system_date_format_localize_form	drupal/core/modules/system/system.admin.inc	Form constructor for the date localization configuration form.
system_modules	drupal/core/modules/system/system.admin.inc	Form constructor for the module enable/disable interface.
system_modules_uninstall	drupal/core/modules/system/system.admin.inc	Form constructor for the uninstalling disabled modules form.
system_themes_admin_form	drupal/core/modules/system/system.admin.inc	Form to select the administration theme.
system_theme_settings	drupal/core/modules/system/system.admin.inc	Form builder; display theme configuration for entire site and individual themes.
taxonomy_overview_terms	drupal/core/modules/taxonomy/taxonomy.admin.inc	Form builder for the taxonomy terms overview.
taxonomy_term_confirm_delete	drupal/core/modules/taxonomy/taxonomy.admin.inc	Form builder for the term delete form.
taxonomy_vocabulary_confirm_delete	drupal/core/modules/taxonomy/taxonomy.admin.inc	Form builder for the vocabulary delete confirmation form.
taxonomy_vocabulary_confirm_reset_alphabetical	drupal/core/modules/taxonomy/taxonomy.admin.inc	Form builder to confirm resetting a vocabulary to alphabetical order.
update_manager_install_form	drupal/core/modules/update/update.manager.inc	Form constructor for the install form of the Update Manager module.
update_manager_update_form	drupal/core/modules/update/update.manager.inc	Form constructor for the update form of the Update Manager module.
update_manager_update_ready_form	drupal/core/modules/update/update.manager.inc	Form constructor for the update ready form.
user_admin_permissions	drupal/core/modules/user/user.admin.inc	Menu callback: administer permissions.
user_cancel_confirm_form	drupal/core/modules/user/user.pages.inc	Form builder; confirm form for cancelling user account.
user_login_form	drupal/core/modules/user/user.module	Form builder; the main user login form.
user_pass	drupal/core/modules/user/user.pages.inc	Form builder; Request a password reset.
_install_configure_form	drupal/core/includes/install.core.inc	Form constructor for a site configuration form.