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".

Functions

Name	Location	Description
aggregator_admin_form	modules/aggregator/aggregator.admin.inc	Form builder; Configure the aggregator system.
aggregator_form_category	modules/aggregator/aggregator.admin.inc	Form builder; Generate a form to add/edit/delete aggregator categories.
aggregator_form_feed	modules/aggregator/aggregator.admin.inc	Form builder; Generate a form to add/edit feed sources.
aggregator_form_opml	modules/aggregator/aggregator.admin.inc	Form builder; Generate a form to import feeds from OPML.
book_admin_edit	modules/book/book.admin.inc	Build the form to administrate the hierarchy of a single book.
book_admin_settings	modules/book/book.admin.inc	Builds and returns the book settings form.
book_outline_form	modules/book/book.pages.inc	Build the form to handle all book outline operations via the outline tab.
book_remove_form	modules/book/book.pages.inc	Menu callback; builds a form to confirm removal of a node from the book.
comment_confirm_delete	modules/comment/comment.admin.inc	Form builder; Builds the confirmation form for deleting a single comment.
comment_form	modules/comment/comment.module	Generate the basic commenting form, for appending to a node or display on a separate page.
comment_unpublish_by_keyword_action_form	modules/comment/comment.module	Form builder; Prepare a form for blacklisted keywords.
confirm_form	modules/system/system.module	Output a confirmation form
dblog_clear_log_form	modules/dblog/dblog.admin.inc	Return form for dblog clear button.
dblog_filter_form	modules/dblog/dblog.admin.inc	Return form for dblog administration filters.
filter_admin_delete	modules/filter/filter.admin.inc	Menu callback; confirm deletion of a format.
filter_admin_format_form	modules/filter/filter.admin.inc	Generate a text format form.
filter_admin_overview	modules/filter/filter.admin.inc	Menu callback; Displays a list of all text formats and allows them to be rearranged.
forum_form_container	modules/forum/forum.admin.inc	Returns a form for adding a container to the forum vocabulary
forum_form_forum	modules/forum/forum.admin.inc	Returns a form for adding a forum to the forum vocabulary
image_effect_delete_form	modules/image/image.admin.inc	Form builder; Form for deleting an image effect.
image_effect_form	modules/image/image.admin.inc	Form builder; Form for adding and editing image effects.
image_style_add_form	modules/image/image.admin.inc	Form builder; Form for adding a new image style.
image_style_delete_form	modules/image/image.admin.inc	Form builder; Form for deleting an image style.
image_style_form	modules/image/image.admin.inc	Form builder; Edit an image style name and effects order.
locale_language_selector_form	modules/locale/locale.module	Form builder callback to display language selection widget.
locale_translation_filter_form	modules/locale/locale.admin.inc	Return form for locale translation filters.
openid_user_add	modules/openid/openid.pages.inc	Form builder; Add an OpenID identity.
overlay_form_after_build	modules/overlay/overlay.module	Form after_build callback.
overlay_form_submit	modules/overlay/overlay.module	Generic form submit handler.
path_admin_filter_form	modules/path/path.admin.inc	Return a form to filter URL aliases.
path_admin_form	modules/path/path.admin.inc	Return a form for editing or creating an individual URL alias.
poll_cancel_form	modules/poll/poll.module	Builds the cancel form for a poll.
poll_view_voting	modules/poll/poll.module	Generates the voting form for a poll.
profile_admin_overview	modules/profile/profile.admin.inc	Form builder to display a listing of all editable profile fields.
profile_field_form	modules/profile/profile.admin.inc	Menu callback: Generate a form to add/edit a user profile field.
search_admin_settings	modules/search/search.admin.inc	Menu callback; displays the search module settings page.
search_box	modules/search/search.module	Form builder; Output a search form for the search block's search box.
shortcut_link_add	modules/shortcut/shortcut.admin.inc	Form callback: builds the form for adding a new shortcut link.
shortcut_link_delete	modules/shortcut/shortcut.admin.inc	Form callback: builds the confirmation form for deleting a shortcut link.
shortcut_link_edit	modules/shortcut/shortcut.admin.inc	Form callback: builds the form for editing a shortcut link.
shortcut_set_add_form	modules/shortcut/shortcut.admin.inc	Form callback: builds the form for adding a shortcut set.
shortcut_set_customize	modules/shortcut/shortcut.admin.inc	Form callback: builds the form for customizing shortcut sets.
shortcut_set_delete_form	modules/shortcut/shortcut.admin.inc	Form callback: builds the confirmation form for deleting a shortcut set.
shortcut_set_edit_form	modules/shortcut/shortcut.admin.inc	Form callback: builds the form for editing the shortcut set name.
shortcut_set_switch	modules/shortcut/shortcut.admin.inc	Form callback: builds the form for switching shortcut sets.
statistics_settings_form	modules/statistics/statistics.admin.inc	Form builder; Configure access logging.
system_actions_delete_form	modules/system/system.admin.inc	Create the form for confirmation of deleting an action.
system_actions_manage_form	modules/system/system.admin.inc	Define the form for the actions overview page.
system_add_date_format_type_form	modules/system/system.admin.inc	Add new date type.
system_clean_url_settings	modules/system/system.admin.inc	Form builder; Configure clean URL settings.
system_clear_cache_submit	modules/system/system.admin.inc	Submit callback; clear system caches.
system_date_time_settings	modules/system/system.admin.inc	Form builder; Configure the site date and time settings.
system_file_system_settings	modules/system/system.admin.inc	Form builder; Configure the site file handling.
system_image_toolkit_settings	modules/system/system.admin.inc	Form builder; Configure site image toolkit usage.
system_ip_blocking_form	modules/system/system.admin.inc	Define the form for blocking IP addresses.
system_logging_settings	modules/system/system.admin.inc	Form builder; Configure error reporting settings.
system_modules	modules/system/system.admin.inc	Menu callback; provides module enable/disable interface.
system_modules_confirm_form	modules/system/system.admin.inc	Display confirmation form for required modules.
system_modules_uninstall	modules/system/system.admin.inc	Builds a form of currently disabled modules.
system_modules_uninstall_confirm_form	modules/system/system.admin.inc	Confirm uninstall of selected modules.
system_performance_settings	modules/system/system.admin.inc	Form builder; Configure site performance settings.
system_regional_settings	modules/system/system.admin.inc	Form builder; Configure the site regional settings.
system_rss_feeds_settings	modules/system/system.admin.inc	Form builder; Configure how the site handles RSS feeds.
system_settings_form	modules/system/system.module	Add default buttons to a form and set its prefix.
system_site_information_settings	modules/system/system.admin.inc	Form builder; The general site information form.
system_site_maintenance_mode	modules/system/system.admin.inc	Form builder; Configure the site's maintenance status.
system_themes_admin_form	modules/system/system.admin.inc	Form to select the administration theme.
taxonomy_form_term	modules/taxonomy/taxonomy.admin.inc	Form function for the term edit form.
taxonomy_form_vocabulary	modules/taxonomy/taxonomy.admin.inc	Display form for adding and editing vocabularies.
taxonomy_overview_terms	modules/taxonomy/taxonomy.admin.inc	Form builder for the taxonomy terms overview.
taxonomy_overview_vocabularies	modules/taxonomy/taxonomy.admin.inc	Form builder to list and manage vocabularies.
taxonomy_term_confirm_delete	modules/taxonomy/taxonomy.admin.inc	Form builder for the term delete form.
taxonomy_term_confirm_parents	modules/taxonomy/taxonomy.admin.inc	Form builder for the confirmation of multiple term parents.
taxonomy_vocabulary_confirm_delete	modules/taxonomy/taxonomy.admin.inc	Form builder for the vocabulary delete confirmation form.
taxonomy_vocabulary_confirm_reset_alphabetical	modules/taxonomy/taxonomy.admin.inc	Form builder to confirm resetting a vocabulary to alphabetical order.
trigger_unassign	modules/trigger/trigger.admin.inc	Confirm removal of an assigned action.
user_admin_account	modules/user/user.admin.inc	Form builder; User administration page.
user_admin_permissions	modules/user/user.admin.inc	Menu callback: administer permissions.
user_admin_role	modules/user/user.admin.inc	Menu callback: administer roles.
user_admin_settings	modules/user/user.admin.inc	Form builder; Configure user settings for this site.
user_cancel_confirm_form	modules/user/user.pages.inc	Form builder; confirm form for cancelling user account.
user_filter_form	modules/user/user.admin.inc	Form builder; Return form for user administration filters.
user_login	modules/user/user.module	Form builder; the main user login form.
user_pass	modules/user/user.pages.inc	Form builder; Request a password reset.
user_profile_form	modules/user/user.pages.inc	Form builder; edit a user account or one of their profile categories.
user_register_form	modules/user/user.module	Form builder; the user registration form.