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

End of "defgroup forms".

File

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

Functions

Namesort descending Location Description
action_admin_configure drupal/core/modules/action/action.admin.inc Form constructor for the configuration of a single action.
action_admin_delete_form drupal/core/modules/action/action.admin.inc Creates the form for confirmation of deleting an action.
action_admin_manage_form drupal/core/modules/action/action.admin.inc Define the form for the actions overview page.
aggregator_admin_form drupal/core/modules/aggregator/aggregator.admin.inc Form constructor for the aggregator system settings.
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_form_feed drupal/core/modules/aggregator/aggregator.admin.inc Form constructor for adding and editing feed sources.
aggregator_form_opml drupal/core/modules/aggregator/aggregator.admin.inc Form constructor for importing feeds from OPML.
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.
ban_ip_form drupal/core/modules/ban/ban.admin.inc Form constructor for banning an IP address.
block_add_block_form drupal/core/modules/block/block.admin.inc Form constructor for the add block form.
block_admin_configure drupal/core/modules/block/block.admin.inc Form constructor for the block configuration form.
block_admin_display_form drupal/core/modules/block/block.admin.inc Form constructor for the main block administration form.
block_custom_block_form drupal/core/modules/block/block.module Form constructor for the custom block form.
book_admin_edit drupal/core/modules/book/book.admin.inc Form constructor for administering a single book's hierarchy.
book_admin_settings drupal/core/modules/book/book.admin.inc Form constructor for the book settings form.
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.
comment_unpublish_by_keyword_action_form drupal/core/modules/comment/comment.module Form constructor for the blacklisted keywords form.
contact_category_delete_form drupal/core/modules/contact/contact.admin.inc Page callback: Form constructor for the contact category deletion form.
contact_personal_form drupal/core/modules/contact/contact.pages.inc Page callback: Form constructor for the personal contact form.
contact_site_form drupal/core/modules/contact/contact.pages.inc Page callback: Form constructor for the site-wide contact 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.
field_ui_display_overview drupal/core/modules/field_ui/field_ui.admin.inc Returns the built and processed 'Manage display' form of a bundle.
field_ui_field_delete_form drupal/core/modules/field_ui/field_ui.admin.inc Form constructor for removing a field instance from a bundle.
field_ui_field_edit_form drupal/core/modules/field_ui/field_ui.admin.inc Form constructor for the field instance settings form.
field_ui_field_overview drupal/core/modules/field_ui/field_ui.admin.inc Returns the built and processed 'Manage fields' form of a bundle.
field_ui_widget_type_form drupal/core/modules/field_ui/field_ui.admin.inc Form constructor for the widget selection form.
file_module_test_form drupal/core/modules/file/tests/file_module_test.module Form constructor for testing a 'managed_file' element.
filter_admin_disable drupal/core/modules/filter/filter.admin.inc Form constructor for the text format deletion confirmation form.
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 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_admin_settings drupal/core/modules/forum/forum.admin.inc Form constructor for the forum settings page.
forum_confirm_delete drupal/core/modules/forum/forum.admin.inc Form constructor for confirming deletion of a forum taxonomy term.
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_delete_form drupal/core/modules/image/image.admin.inc Form builder; Form for deleting an image effect.
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_delete_form drupal/core/modules/image/image.admin.inc Form builder; Form for deleting an 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.
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.
menu_configure drupal/core/modules/menu/menu.admin.inc Menu callback; Build the form presenting menu configuration options.
node_admin_content drupal/core/modules/node/node.admin.inc Page callback: Form constructor for the content administration form.
node_admin_nodes drupal/core/modules/node/node.admin.inc Returns the admin form object to node_admin_content().
node_assign_owner_action_form drupal/core/modules/node/node.module Form constructor for the settings form for node_assign_owner_action().
node_configure_rebuild_confirm drupal/core/modules/node/node.admin.inc Page callback: Form constructor for the permission rebuild confirmation form.
node_filter_form drupal/core/modules/node/node.admin.inc Returns the node administration filters form array to node_admin_content().
node_multiple_delete_confirm drupal/core/modules/node/node.admin.inc Multiple node deletion confirmation form for node_admin_content().
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.
openid_user_add drupal/core/modules/openid/openid.pages.inc Form builder; Add an OpenID identity.
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.
poll_cancel_form drupal/core/modules/poll/poll.module Form constructor for the poll cancel form.
poll_view_voting drupal/core/modules/poll/poll.module Form constructor for the poll voting form.
rest_admin_form drupal/core/modules/rest/rest.admin.inc Form constructor for the REST admin form.
search_admin_settings drupal/core/modules/search/search.admin.inc Menu callback: displays the search module settings page.
search_box drupal/core/modules/search/search.module Form builder; Output a search form 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_delete drupal/core/modules/shortcut/shortcut.admin.inc Form callback: builds the confirmation form for deleting a shortcut link.
shortcut_link_edit drupal/core/modules/shortcut/shortcut.admin.inc Form callback: builds the form for editing a shortcut link.
shortcut_set_add_form drupal/core/modules/shortcut/shortcut.admin.inc Form callback: builds the form for adding a shortcut set.
shortcut_set_customize drupal/core/modules/shortcut/shortcut.admin.inc Form callback: builds the form for customizing shortcut sets.
shortcut_set_delete_form drupal/core/modules/shortcut/shortcut.admin.inc Form callback: builds the confirmation form for deleting a shortcut set.
shortcut_set_edit_form drupal/core/modules/shortcut/shortcut.admin.inc Form callback: builds the form for editing the shortcut set name.
shortcut_set_switch drupal/core/modules/shortcut/shortcut.admin.inc Form callback: builds the form for switching shortcut sets.
simpletest_settings_form drupal/core/modules/simpletest/simpletest.pages.inc Provides settings form for SimpleTest variables.
statistics_settings_form drupal/core/modules/statistics/statistics.admin.inc Form constructor for the statistics administration form.
system_clear_cache_submit drupal/core/modules/system/system.admin.inc Submit callback; clear system caches.
system_clear_page_cache_submit drupal/core/modules/system/system.admin.inc Submit callback; clear the page cache.
system_config_form drupal/core/modules/system/system.module Adds default behavior to a configuration form.
system_cron_settings drupal/core/modules/system/system.admin.inc Form builder; Cron form.
system_cron_settings_submit drupal/core/modules/system/system.admin.inc Form builder submit handler; Handle submission for cron settings.
system_date_format_localize_form drupal/core/modules/system/system.admin.inc Form constructor for the date localization configuration form.
system_date_format_localize_reset_form drupal/core/modules/system/system.admin.inc Form constructor for the reset date format form.
system_file_system_settings drupal/core/modules/system/system.admin.inc Form builder; Configure the site file handling.
system_image_toolkit_settings drupal/core/modules/system/system.admin.inc Form builder; Configure site image toolkit usage.
system_logging_settings drupal/core/modules/system/system.admin.inc Form builder; Configure error reporting settings.
system_logging_settings_submit drupal/core/modules/system/system.admin.inc Form submission handler for system_logging_settings().
system_modules drupal/core/modules/system/system.admin.inc Menu callback; provides module enable/disable interface.
system_modules_confirm_form drupal/core/modules/system/system.admin.inc Display confirmation form for required modules.
system_modules_uninstall drupal/core/modules/system/system.admin.inc Builds a form of currently disabled modules.
system_modules_uninstall_confirm_form drupal/core/modules/system/system.admin.inc Confirm uninstall of selected modules.
system_performance_settings drupal/core/modules/system/system.admin.inc Form builder; Configure site performance settings.
system_performance_settings_submit drupal/core/modules/system/system.admin.inc Form submission handler for system_performance_settings().
system_regional_settings drupal/core/modules/system/system.admin.inc Form builder; Configure the site regional settings.
system_regional_settings_submit drupal/core/modules/system/system.admin.inc Form builder submit handler; Handles submission for regional settings.
system_rss_feeds_settings drupal/core/modules/system/system.admin.inc Form builder; Configure how the site handles RSS feeds.
system_rss_feeds_settings_submit drupal/core/modules/system/system.admin.inc Form builder submit handler; Handle submission for RSS feeds settings.
system_run_cron_submit drupal/core/modules/system/system.admin.inc Submit callback; run cron.
system_settings_form drupal/core/modules/system/system.module Add default buttons to a form and set its prefix.
system_site_information_settings drupal/core/modules/system/system.admin.inc Form builder; The general site information form.
system_site_maintenance_mode drupal/core/modules/system/system.admin.inc Form builder; Configure the site's maintenance status.
system_site_maintenance_mode_submit drupal/core/modules/system/system.admin.inc Form submission handler for system_site_maintenance_mode().
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_overview_vocabularies drupal/core/modules/taxonomy/taxonomy.admin.inc Form builder to list and manage vocabularies.
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.
update_settings drupal/core/modules/update/update.settings.inc Form constructor for the update settings form.
user_admin_account drupal/core/modules/user/user.admin.inc Form builder; User administration page.
user_admin_permissions drupal/core/modules/user/user.admin.inc Menu callback: administer permissions.
user_admin_role drupal/core/modules/user/user.admin.inc Form to configure a single role.
user_admin_roles drupal/core/modules/user/user.admin.inc Form to re-order roles or add a new one.
user_admin_settings drupal/core/modules/user/user.admin.inc Form builder; Configure user settings for this site.
user_cancel_confirm_form drupal/core/modules/user/user.pages.inc Form builder; confirm form for cancelling user account.
user_filter_form drupal/core/modules/user/user.admin.inc Form builder; Return form for user administration filters.
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.
views_ui_admin_settings_advanced_submit drupal/core/modules/views/views_ui/admin.inc Form builder submit handler; Handle submission the basic views settings..
views_ui_admin_settings_basic_submit drupal/core/modules/views/views_ui/admin.inc Form builder submit handler; Handle submission the basic views settings.
_install_configure_form drupal/core/includes/install.core.inc Form constructor for a site configuration form.