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:

End of "defgroup forms".

File

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

Functions

Name Locationsort descending Description
authorize_filetransfer_form core/includes/authorize.inc Form constructor for the file transfer authorization form.
install_settings_form core/includes/install.core.inc Form constructor for a form to configure and rewrite settings.php.
install_select_profile_form core/includes/install.core.inc Form constructor for the profile selection form.
install_select_language_form core/includes/install.core.inc Form constructor for the language selection form.
install_configure_form core/includes/install.core.inc Form constructor for a form to configure the new site.
_install_configure_form core/includes/install.core.inc Form constructor for a site configuration form.
block_admin_configure core/modules/block/block.admin.inc Form constructor for the block configuration form.
block_add_block_form core/modules/block/block.admin.inc Form constructor for the add block form.
block_custom_block_translate_list core/modules/block/block.admin.inc Form constructor for the block translation list form.
block_custom_block_form core/modules/block/block.module Form constructor for the custom block form.
book_admin_settings core/modules/book/book.admin.inc Form constructor for the book settings form.
book_admin_edit core/modules/book/book.admin.inc Form constructor for administering a single book's hierarchy.
book_remove_form core/modules/book/book.pages.inc Form constructor to confirm removal of a node from a book.
comment_admin_overview core/modules/comment/comment.admin.inc Form constructor for the comment overview administration form.
comment_multiple_delete_confirm core/modules/comment/comment.admin.inc Form constructor for the confirmation form for bulk comment deletion.
comment_confirm_delete core/modules/comment/comment.admin.inc Form constructor for the confirmation form for comment deletion.
comment_form core/modules/comment/comment.module Form constructor for the basic commenting form.
contact_settings_form core/modules/contact/contact.admin.inc Contact settings form.
contact_category_edit_form core/modules/contact/contact.admin.inc Form constructor for the category edit form.
contact_site_form core/modules/contact/contact.pages.inc Form constructor for the site-wide contact form.
contact_personal_form core/modules/contact/contact.pages.inc Form constructor for the personal contact form.
dblog_filter_form core/modules/dblog/dblog.admin.inc Form constructor for the database logging filter form.
dblog_clear_log_form core/modules/dblog/dblog.admin.inc Form constructor for the form that clears out the log.
field_ui_field_overview_form core/modules/field_ui/field_ui.admin.inc Form constructor for the 'Manage fields' form of a bundle.
field_ui_display_overview core/modules/field_ui/field_ui.admin.inc Form constructor for the field display settings for a given display mode.
field_ui_display_form core/modules/field_ui/field_ui.admin.inc Form constructor for the field display settings for a given display mode.
field_ui_field_settings_form core/modules/field_ui/field_ui.admin.inc Form constructor for the field settings edit page.
field_ui_widget_type_form core/modules/field_ui/field_ui.admin.inc Form constructor for the widget selection form.
field_ui_field_delete_form core/modules/field_ui/field_ui.admin.inc Form constructor for removing a field instance from a bundle.
field_ui_field_edit_form core/modules/field_ui/field_ui.admin.inc Form constructor for the field instance settings form.
file_type_classify_confirm core/modules/file/file.admin.inc Confirm form for file type classification process.
file_multiple_delete_confirm core/modules/file/file.pages.inc Multiple file deletion confirmation form.
file_module_test_form core/modules/file/tests/file_module_test/file_module_test.module Form constructor for testing a 'managed_file' element.
filter_admin_overview core/modules/filter/filter.admin.inc Page callback: Form constructor for a form to list and reorder text formats.
filter_admin_format_form core/modules/filter/filter.admin.inc Form constructor for the text format add/edit form.
filter_admin_disable core/modules/filter/filter.admin.inc Form constructor for the text format deletion confirmation form.
filter_editor_image_upload_settings_form core/modules/filter/filter.admin.inc Subform constructor to configure the text editor's image upload settings.
filter_editor_file_upload_settings_form core/modules/filter/filter.admin.inc Subform constructor to configure the text editor's file upload settings.
image_style_form core/modules/image/image.admin.inc Form builder; Configure an image style name and effects order.
image_style_add_form core/modules/image/image.admin.inc Form builder; Form for adding a new image style.
image_style_delete_form core/modules/image/image.admin.inc Form builder; Form for deleting an image style.
image_effect_form core/modules/image/image.admin.inc Form builder; Form for adding and editing image effects.
image_effect_delete_form core/modules/image/image.admin.inc Form builder; Form for deleting an image effect.
installer_manager_update_form core/modules/installer/installer.manager.inc Form constructor for the update form of the Installer module.
installer_manager_update_ready_form core/modules/installer/installer.manager.inc Form constructor for the update ready form.
installer_manager_install_form core/modules/installer/installer.manager.inc Form constructor for the install form of the Installer module.
layout_settings_form core/modules/layout/layout.admin.inc Render the settings form for layout.
layout_content_form core/modules/layout/layout.admin.inc Form callback; Main form for editing a layout's content.
layout_title_settings_form core/modules/layout/layout.admin.inc Form callback; Configure layout title type.
layout_block_configure_form core/modules/layout/layout.admin.inc Form callback; Add or edit a block within a layout.
layout_condition_add_form core/modules/layout/layout.admin.inc Form callback; Displays form for adding new conditions to a layout or block.
layout_reorder_form core/modules/layout/layout.admin.inc Reorder the order of layouts at the same path.
layout_clone_form core/modules/layout/layout.admin.inc Form callback; Copy an existing layout into a new layout.
layout_delete_form core/modules/layout/layout.admin.inc Form callback. Delete or revert a layout.
layout_menu_item_form core/modules/layout/layout.admin.inc Form callback; Configure a layout menu item.
layout_context_add_form core/modules/layout/layout.context.admin.inc Form callback; Displays form for adding new contexts to a layout.
layout_context_relationship_add_form core/modules/layout/layout.context.admin.inc Form callback; Displays form for adding new relationships to a layout.
layout_entity_admin_form core/modules/layout/layout.entity.admin.inc Render the settings form for listing entity layouts.
layout_entity_admin_add_form core/modules/layout/layout.entity.admin.inc Render the form for adding a layout for an entity.
layout_flexible_template_settings_add_form core/modules/layout/layout.flexible.inc Form to add a flexible template.
layout_flexible_template_settings_edit_form core/modules/layout/layout.flexible.inc Form to configure a flexible template.
layout_flexible_template_configure_form core/modules/layout/layout.flexible.inc Form to manage adding and removing rows to a flexible template.
layout_flexible_template_region_style_select core/modules/layout/layout.flexible.inc Form to select the region widths for a flexible template.
layout_flexible_template_edit_row_form core/modules/layout/layout.flexible.inc Form to add or edit a row on a flexible template.
layout_flexible_template_delete_row core/modules/layout/layout.flexible.inc Menu callback to delete a row from a flexible template.
layout_flexible_template_delete_form core/modules/layout/layout.flexible.inc Menu callback; Delete a flexible template.
locale_language_selector_form core/modules/locale/locale.module Form builder callback to display language selection widget.
locale_translation_filter_form core/modules/locale/locale.pages.inc Return form for locale translation filters.
locale_translate_edit_form core/modules/locale/locale.pages.inc User interface for string editing.
locale_translate_delete_form core/modules/locale/locale.pages.inc User interface for the string deletion confirmation screen.
node_configure_rebuild_confirm core/modules/node/node.admin.inc Menu callback: confirm rebuilding of permissions.
node_multiple_delete_confirm core/modules/node/node.admin.inc Multiple node deletion confirmation form.
node_form core/modules/node/node.pages.inc Form constructor for the node add/edit form.
node_revision_revert_confirm core/modules/node/node.pages.inc Asks for confirmation of the reversion to prevent against CSRF attacks.
node_revision_delete_confirm core/modules/node/node.pages.inc Form constructor for the revision deletion confirmation form.
node_type_form core/modules/node/node.types.inc Form constructor for the node type editing form.
node_type_delete_confirm core/modules/node/node.types.inc Menu callback; delete a single content type.
path_admin_form core/modules/path/path.admin.inc Form builder; Main URL alias pattern administration form.
path_admin_filter_form core/modules/path/path.admin.inc Form constructor for the path admin overview filter form.
path_patterns_form core/modules/path/path.admin.inc Form builder; Configure the URL alias patterns.
path_patterns_settings_form core/modules/path/path.admin.inc Form builder; Configure the URL alias pattern settings.
path_bulk_update_form core/modules/path/path.admin.inc Form builder; Bulk URL alias update form.
redirect_list_filter_form core/modules/redirect/redirect.admin.inc Return a partial form to filter URL redirects.
redirect_edit_form core/modules/redirect/redirect.admin.inc Form builder to add or edit an URL redirect.
redirect_delete_form core/modules/redirect/redirect.admin.inc Form builder to delete an URL redirect.
redirect_settings_form core/modules/redirect/redirect.admin.inc Form builder for redirection settings.
redirect_list_404_filter_form core/modules/redirect/redirect.admin.inc Return a form to filter URL redirects.
search_admin_settings core/modules/search/search.admin.inc Menu callback: displays the search module settings page.
search_box core/modules/search/search.module Form builder; Output a search form for the search block's search box.
simpletest_settings_form core/modules/simpletest/simpletest.pages.inc Provides settings form for SimpleTest variables.
form_test_color core/modules/simpletest/tests/form_test.module Form constructor for testing #type 'color' elements.
form_test_email core/modules/simpletest/tests/form_test.module Form constructor for testing #type 'email' elements.
form_test_h5datetime core/modules/simpletest/tests/form_test.module Form constructor for #type html_date, html_time and html_datetime elements.
form_test_url core/modules/simpletest/tests/form_test.module Form constructor for testing #type 'url' elements.
system_themes_admin_form core/modules/system/system.admin.inc Form to select the administration theme.
system_theme_disable_confirm core/modules/system/system.admin.inc Theme disable confirmation form.
system_theme_settings core/modules/system/system.admin.inc Form builder; display configuration for individual themes.
system_modules core/modules/system/system.admin.inc Menu callback; provides module enable/disable interface.
system_modules_confirm_form core/modules/system/system.admin.inc Display confirmation form for required modules.
system_modules_uninstall core/modules/system/system.admin.inc Builds a form of currently disabled modules.
system_modules_uninstall_confirm_form core/modules/system/system.admin.inc Confirm uninstall of selected modules.
system_site_information_settings core/modules/system/system.admin.inc Form builder; The general site information form.
system_cron_settings core/modules/system/system.admin.inc Form builder; Cron form.
system_run_cron_submit core/modules/system/system.admin.inc Submit callback; run cron.
system_logging_settings core/modules/system/system.admin.inc Form builder; Configure error reporting settings.
system_performance_settings core/modules/system/system.admin.inc Form builder; Configure site performance settings.
system_jquery_settings core/modules/system/system.admin.inc Form builder; Configure jQuery settings.
system_clear_cache_submit core/modules/system/system.admin.inc Submit callback; clear system caches.
system_clear_page_cache_submit core/modules/system/system.admin.inc Submit callback; clear the page cache.
system_file_system_settings core/modules/system/system.admin.inc Form builder; Configure the site file handling.
system_image_toolkit_settings core/modules/system/system.admin.inc Form builder; Configure site image toolkit usage.
system_rss_feeds_settings core/modules/system/system.admin.inc Form builder; Configure how the site handles RSS feeds.
system_regional_settings core/modules/system/system.admin.inc Form builder; Configure the site regional settings.
system_regional_settings_submit core/modules/system/system.admin.inc Form submission handler for regional settings.
system_site_maintenance_mode core/modules/system/system.admin.inc Form builder; Configure the site's maintenance status.
system_urls_settings core/modules/system/system.admin.inc Form builder; Configure clean URL settings.
system_transliteration_retroactive core/modules/system/system.admin.inc Form builder function; generates retroactive transliteration confirm form.
taxonomy_form_vocabulary core/modules/taxonomy/taxonomy.admin.inc Form builder for the vocabulary editing form.
taxonomy_overview_terms core/modules/taxonomy/taxonomy.admin.inc Form builder for the taxonomy terms overview.
taxonomy_form_term core/modules/taxonomy/taxonomy.admin.inc Form function for the term edit form.
taxonomy_term_confirm_delete core/modules/taxonomy/taxonomy.admin.inc Form builder for the term delete form.
taxonomy_vocabulary_confirm_delete core/modules/taxonomy/taxonomy.admin.inc Form builder for the vocabulary delete confirmation form.
taxonomy_vocabulary_confirm_reset_alphabetical core/modules/taxonomy/taxonomy.admin.inc Form builder to confirm resetting a vocabulary to alphabetical order.
update_settings core/modules/update/update.admin.inc Form constructor for the update settings form.
user_multiple_cancel_confirm core/modules/user/user.admin.inc Form builder; Cancel multiple accounts at the same time.
user_admin_settings core/modules/user/user.admin.inc Form builder; Configure user settings for this site.
user_login_settings core/modules/user/user.admin.inc Login settings form.
user_admin_permissions core/modules/user/user.admin.inc Menu callback: administer permissions.
user_admin_roles core/modules/user/user.admin.inc Form to re-order roles.
user_admin_role core/modules/user/user.admin.inc Form to add or configure a single role.
user_settings_email core/modules/user/user.admin.inc Form builder; Configure user email settings for this site.
user_login core/modules/user/user.module Form builder; the main user login form.
user_register_form core/modules/user/user.module Form builder; the user registration form.
user_pass core/modules/user/user.pages.inc Form builder; request a password reset.
user_pass_reset_form core/modules/user/user.pages.inc Form builder; one time login form with password reset.
user_profile_form core/modules/user/user.pages.inc Form builder; edit a user account.
user_cancel_confirm_form core/modules/user/user.pages.inc Form builder; confirm form for canceling user account.
contextual_links_example_object_edit_form modules/examples/contextual_links_example/contextual_links_example.module Form callback; display the form for editing our module's content.
contextual_links_example_node_action_form modules/examples/contextual_links_example/contextual_links_example.module Form callback; display the form for performing an example action on a node.