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

Functions & methods

NameLocationDescription
aggregator_admin_formmodules/aggregator/aggregator.admin.incForm constructor for the aggregator system settings.
aggregator_categorize_itemsmodules/aggregator/aggregator.pages.incForm constructor to build the page list form.
aggregator_form_categorymodules/aggregator/aggregator.admin.incForm constructor to add/edit/delete aggregator categories.
aggregator_form_feedmodules/aggregator/aggregator.admin.incForm constructor for adding and editing feed sources.
aggregator_form_opmlmodules/aggregator/aggregator.admin.incForm constructor for importing feeds from OPML.
authorize_filetransfer_formincludes/authorize.incForm constructor for the file transfer authorization form.
block_add_block_formmodules/block/block.admin.incForm constructor for the add block form.
block_admin_configuremodules/block/block.admin.incForm constructor for the block configuration form.
block_admin_display_formmodules/block/block.admin.incForm constructor for the main block administration form.
block_custom_block_formmodules/block/block.moduleForm constructor for the custom block form.
book_admin_editmodules/book/book.admin.incForm constructor for administering a single book's hierarchy.
book_admin_settingsmodules/book/book.admin.incForm constructor for the book settings form.
book_outline_formmodules/book/book.pages.incForm constructor for the book outline form.
book_remove_formmodules/book/book.pages.incForm constructor to confirm removal of a node from a book.
color_scheme_formmodules/color/color.moduleForm constructor for the color configuration form for a particular theme.
comment_admin_overviewmodules/comment/comment.admin.incForm builder for the comment overview administration form.
comment_confirm_deletemodules/comment/comment.admin.incForm builder; Builds the confirmation form for deleting a single comment.
comment_formmodules/comment/comment.moduleGenerate the basic commenting form, for appending to a node or display on a separate page.
comment_multiple_delete_confirmmodules/comment/comment.admin.incList the selected comments and verify that the admin wants to delete them.
comment_unpublish_by_keyword_action_formmodules/comment/comment.moduleForm builder; Prepare a form for blacklisted keywords.
contact_category_edit_formmodules/contact/contact.admin.incForm constructor for the category edit form.
contact_personal_formmodules/contact/contact.pages.incForm constructor for the personal contact form.
contact_site_formmodules/contact/contact.pages.incForm constructor for the site-wide contact form.
dblog_clear_log_formmodules/dblog/dblog.admin.incReturn form for dblog clear button.
dblog_filter_formmodules/dblog/dblog.admin.incReturn form for dblog administration filters.
field_ui_display_overview_formmodules/field_ui/field_ui.admin.incForm constructor for the field display settings for a given view mode.
field_ui_field_delete_formmodules/field_ui/field_ui.admin.incForm constructor for removing a field instance from a bundle.
field_ui_field_edit_formmodules/field_ui/field_ui.admin.incForm constructor for the field instance settings form.
field_ui_field_overview_formmodules/field_ui/field_ui.admin.incForm constructor for the 'Manage fields' form of a bundle.
field_ui_widget_type_formmodules/field_ui/field_ui.admin.incForm constructor for the widget selection form.
file_module_test_formmodules/file/tests/file_module_test.moduleForm constructor for testing a 'managed_file' element.
filter_admin_disablemodules/filter/filter.admin.incMenu callback; confirm deletion of a format.
filter_admin_format_formmodules/filter/filter.admin.incGenerate a text format form.
filter_admin_overviewmodules/filter/filter.admin.incMenu callback; Displays a list of all text formats and allows them to be rearranged.
forum_admin_settingsmodules/forum/forum.admin.incForm constructor for the forum settings page.
forum_confirm_deletemodules/forum/forum.admin.incForm constructor for confirming deletion of a forum taxonomy term.
forum_form_containermodules/forum/forum.admin.incForm constructor for adding and editing forum containers.
forum_form_forummodules/forum/forum.admin.incForm constructor for adding and editing a forum.
forum_overviewmodules/forum/forum.admin.incForm constructor for the forum overview form.
image_effect_delete_formmodules/image/image.admin.incForm builder; Form for deleting an image effect.
image_effect_formmodules/image/image.admin.incForm builder; Form for adding and editing image effects.
image_style_add_formmodules/image/image.admin.incForm builder; Form for adding a new image style.
image_style_delete_formmodules/image/image.admin.incForm builder; Form for deleting an image style.
image_style_formmodules/image/image.admin.incForm builder; Edit an image style name and effects order.
locale_language_selector_formmodules/locale/locale.moduleForm builder callback to display language selection widget.
locale_translation_filter_formmodules/locale/locale.admin.incReturn form for locale translation filters.
node_type_formmodules/node/content_types.incForm constructor for the node type editing form.
openid_user_addmodules/openid/openid.pages.incForm builder; Add an OpenID identity.
path_admin_filter_formmodules/path/path.admin.incForm constructor for the path admin overview filter form.
path_admin_formmodules/path/path.admin.incForm constructor for the path administration form.
poll_cancel_formmodules/poll/poll.moduleBuilds the cancel form for a poll.
poll_view_votingmodules/poll/poll.moduleGenerates the voting form for a poll.
profile_admin_overviewmodules/profile/profile.admin.incForm builder to display a listing of all editable profile fields.
profile_field_formmodules/profile/profile.admin.incMenu callback: Generate a form to add/edit a user profile field.
search_admin_settingsmodules/search/search.admin.incMenu callback: displays the search module settings page.
search_boxmodules/search/search.moduleForm builder; Output a search form for the search block's search box.
shortcut_link_addmodules/shortcut/shortcut.admin.incForm callback: builds the form for adding a new shortcut link.
shortcut_link_deletemodules/shortcut/shortcut.admin.incForm callback: builds the confirmation form for deleting a shortcut link.
shortcut_link_editmodules/shortcut/shortcut.admin.incForm callback: builds the form for editing a shortcut link.
shortcut_set_add_formmodules/shortcut/shortcut.admin.incForm callback: builds the form for adding a shortcut set.
shortcut_set_customizemodules/shortcut/shortcut.admin.incForm callback: builds the form for customizing shortcut sets.
shortcut_set_delete_formmodules/shortcut/shortcut.admin.incForm callback: builds the confirmation form for deleting a shortcut set.
shortcut_set_edit_formmodules/shortcut/shortcut.admin.incForm callback: builds the form for editing the shortcut set name.
shortcut_set_switchmodules/shortcut/shortcut.admin.incForm callback: builds the form for switching shortcut sets.
simpletest_settings_formmodules/simpletest/simpletest.pages.incProvides settings form for SimpleTest variables.
statistics_settings_formmodules/statistics/statistics.admin.incForm constructor for the statistics administration form.
system_actions_delete_formmodules/system/system.admin.incCreate the form for confirmation of deleting an action.
system_actions_manage_formmodules/system/system.admin.incDefine the form for the actions overview page.
system_add_date_format_type_formmodules/system/system.admin.incAdd new date type.
system_clean_url_settingsmodules/system/system.admin.incForm builder; Configure clean URL settings.
system_clear_cache_submitmodules/system/system.admin.incSubmit callback; clear system caches.
system_clear_page_cache_submitmodules/system/system.admin.incSubmit callback; clear the page cache.
system_cron_settingsmodules/system/system.admin.incForm builder; Cron form.
system_date_time_settingsmodules/system/system.admin.incForm builder; Configure the site date and time settings.
system_file_system_settingsmodules/system/system.admin.incForm builder; Configure the site file handling.
system_image_toolkit_settingsmodules/system/system.admin.incForm builder; Configure site image toolkit usage.
system_ip_blocking_formmodules/system/system.admin.incDefine the form for blocking IP addresses.
system_logging_settingsmodules/system/system.admin.incForm builder; Configure error reporting settings.
system_modulesmodules/system/system.admin.incMenu callback; provides module enable/disable interface.
system_modules_confirm_formmodules/system/system.admin.incDisplay confirmation form for required modules.
system_modules_uninstallmodules/system/system.admin.incBuilds a form of currently disabled modules.
system_modules_uninstall_confirm_formmodules/system/system.admin.incConfirm uninstall of selected modules.
system_performance_settingsmodules/system/system.admin.incForm builder; Configure site performance settings.
system_regional_settingsmodules/system/system.admin.incForm builder; Configure the site regional settings.
system_rss_feeds_settingsmodules/system/system.admin.incForm builder; Configure how the site handles RSS feeds.
system_run_cron_submitmodules/system/system.admin.incSubmit callback; run cron.
system_settings_formmodules/system/system.moduleAdd default buttons to a form and set its prefix.
system_site_information_settingsmodules/system/system.admin.incForm builder; The general site information form.
system_site_maintenance_modemodules/system/system.admin.incForm builder; Configure the site's maintenance status.
system_themes_admin_formmodules/system/system.admin.incForm to select the administration theme.
system_theme_settingsmodules/system/system.admin.incForm builder; display theme configuration for entire site and individual themes.
taxonomy_form_termmodules/taxonomy/taxonomy.admin.incForm function for the term edit form.
taxonomy_form_vocabularymodules/taxonomy/taxonomy.admin.incForm builder for the vocabulary editing form.
taxonomy_overview_termsmodules/taxonomy/taxonomy.admin.incForm builder for the taxonomy terms overview.
taxonomy_overview_vocabulariesmodules/taxonomy/taxonomy.admin.incForm builder to list and manage vocabularies.
taxonomy_term_confirm_deletemodules/taxonomy/taxonomy.admin.incForm builder for the term delete form.
taxonomy_vocabulary_confirm_deletemodules/taxonomy/taxonomy.admin.incForm builder for the vocabulary delete confirmation form.
taxonomy_vocabulary_confirm_reset_alphabeticalmodules/taxonomy/taxonomy.admin.incForm builder to confirm resetting a vocabulary to alphabetical order.
trigger_assign_formmodules/trigger/trigger.admin.incReturns the form for assigning an action to a trigger.
trigger_unassignmodules/trigger/trigger.admin.incForm constructor for confirmation page for removal of an assigned action.
update_manager_install_formmodules/update/update.manager.incForm constructor for the install form of the Update Manager module.
update_manager_update_formmodules/update/update.manager.incForm constructor for the update form of the Update Manager module.
update_manager_update_ready_formmodules/update/update.manager.incForm constructor for the update ready form.
update_settingsmodules/update/update.settings.incForm constructor for the update settings form.
user_admin_accountmodules/user/user.admin.incForm builder; User administration page.
user_admin_permissionsmodules/user/user.admin.incMenu callback: administer permissions.
user_admin_rolemodules/user/user.admin.incForm to configure a single role.
user_admin_rolesmodules/user/user.admin.incForm to re-order roles or add a new one.
user_admin_settingsmodules/user/user.admin.incForm builder; Configure user settings for this site.
user_cancel_confirm_formmodules/user/user.pages.incForm builder; confirm form for cancelling user account.
user_filter_formmodules/user/user.admin.incForm builder; Return form for user administration filters.
user_loginmodules/user/user.moduleForm builder; the main user login form.
user_passmodules/user/user.pages.incForm builder; Request a password reset.
user_profile_formmodules/user/user.pages.incForm builder; edit a user account or one of their profile categories.
user_register_formmodules/user/user.moduleForm builder; the user registration form.

File

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