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

Namesort iconLocationDescription
aggregator_admin_settingsdrupal/modules/aggregator/aggregator.admin.incForm builder; Configure the aggregator system.
aggregator_categorize_itemsdrupal/modules/aggregator/aggregator.pages.incForm builder; build the page list form.
aggregator_form_categorydrupal/modules/aggregator/aggregator.admin.incForm builder; Generate a form to add/edit/delete aggregator categories.
aggregator_form_feeddrupal/modules/aggregator/aggregator.admin.incForm builder; Generate a form to add/edit feed sources.
aggregator_form_opmldrupal/modules/aggregator/aggregator.admin.incForm builder; Generate a form to import feeds from OPML.
book_admin_editdrupal/modules/book/book.admin.incBuild the form to administrate the hierarchy of a single book.
book_admin_settingsdrupal/modules/book/book.admin.incBuilds and returns the book settings form.
book_outline_formdrupal/modules/book/book.pages.incBuild the form to handle all book outline operations via the outline tab.
book_remove_formdrupal/modules/book/book.pages.incMenu callback; builds a form to confirm removal of a node from the book.
comment_admin_overviewdrupal/modules/comment/comment.admin.incForm builder; Builds the comment overview form for the admin.
comment_confirm_deletedrupal/modules/comment/comment.admin.incForm builder; Builds the confirmation form for deleting a single comment.
comment_editdrupal/modules/comment/comment.pages.incForm builder; generate a comment editing form.
comment_formdrupal/modules/comment/comment.moduleGenerate the basic commenting form, for appending to a node or display on a separate page.
comment_form_add_previewdrupal/modules/comment/comment.moduleForm builder; Generate and validate a comment preview form.
comment_multiple_delete_confirmdrupal/modules/comment/comment.admin.incList the selected comments and verify that the admin wants to delete them.
comment_unpublish_by_keyword_action_formdrupal/modules/comment/comment.moduleForm builder; Prepare a form for blacklisted keywords.
confirm_formdrupal/modules/system/system.moduleOutput a confirmation form
dblog_admin_settingsdrupal/modules/dblog/dblog.admin.incdblog module settings form.
dblog_filter_formdrupal/modules/dblog/dblog.admin.incReturn form for dblog administration filters.
filter_admin_configuredrupal/modules/filter/filter.admin.incBuild a form to change the settings for a format's filters.
filter_admin_deletedrupal/modules/filter/filter.admin.incMenu callback; confirm deletion of a format.
filter_admin_format_formdrupal/modules/filter/filter.admin.incGenerate a filter format form.
filter_admin_orderdrupal/modules/filter/filter.admin.incBuild the form for ordering filters for a format.
filter_admin_overviewdrupal/modules/filter/filter.admin.incMenu callback; Displays a list of all input formats and which one is the default.
filter_formdrupal/modules/filter/filter.moduleGenerate a selector for choosing a format in a form.
forum_form_containerdrupal/modules/forum/forum.admin.incReturns a form for adding a container to the forum vocabulary
forum_form_forumdrupal/modules/forum/forum.admin.incReturns a form for adding a forum to the forum vocabulary
openid_user_adddrupal/modules/openid/openid.pages.incForm builder; Add an OpenID identity.
path_admin_filter_formdrupal/modules/path/path.admin.incReturn a form to filter URL aliases.
path_admin_formdrupal/modules/path/path.admin.incReturn a form for editing or creating an individual URL alias.
poll_cancel_formdrupal/modules/poll/poll.moduleBuilds the cancel form for a poll.
poll_view_votingdrupal/modules/poll/poll.moduleGenerates the voting form for a poll.
profile_admin_overviewdrupal/modules/profile/profile.admin.incForm builder to display a listing of all editable profile fields.
profile_field_formdrupal/modules/profile/profile.admin.incMenu callback: Generate a form to add/edit a user profile field.
scaffolding_example_delete_confirmcontributions/docs/developer/examples/scaffolding_example/scaffolding_example.admin.incBuild the delete confirmation form.
scaffolding_example_formcontributions/docs/developer/examples/scaffolding_example/scaffolding_example.admin.incBuild the record editing form.
scaffolding_example_overview_formcontributions/docs/developer/examples/scaffolding_example/scaffolding_example.admin.incBuild an overview form with drag and drop re-ordering of records.
search_admin_settingsdrupal/modules/search/search.admin.incMenu callback; displays the search module settings page.
search_boxdrupal/modules/search/search.moduleForm builder; Output a search form for the search block and the theme's search box.
statistics_access_logging_settingsdrupal/modules/statistics/statistics.admin.incForm builder; Configure access logging.
system_actions_delete_formdrupal/modules/system/system.moduleCreate the form for confirmation of deleting an action.
system_actions_manage_formdrupal/modules/system/system.moduleDefine the form for the actions overview page.
system_admin_theme_settingsdrupal/modules/system/system.admin.incForm builder; This function allows selection of the theme to show in administration sections.
system_clean_url_settingsdrupal/modules/system/system.admin.incForm builder; Configure Clean URL settings.
system_clear_cache_submitdrupal/modules/system/system.admin.incSubmit callback; clear system caches.
system_date_time_settingsdrupal/modules/system/system.admin.incForm builder; Configure the site date and time settings.
system_error_reporting_settingsdrupal/modules/system/system.admin.incForm builder; Configure error reporting settings.
system_file_system_settingsdrupal/modules/system/system.admin.incForm builder; Configure the site file handling.
system_image_toolkit_settingsdrupal/modules/system/system.admin.incForm builder; Configure site image toolkit usage.
system_ip_blocking_formdrupal/modules/system/system.admin.incDefine the form for blocking IP addresses.
system_modulesdrupal/modules/system/system.admin.incMenu callback; provides module enable/disable interface.
system_modules_confirm_formdrupal/modules/system/system.admin.incDisplay confirmation form for dependencies.
system_modules_uninstalldrupal/modules/system/system.admin.incBuilds a form of currently disabled modules.
system_modules_uninstall_confirm_formdrupal/modules/system/system.admin.incConfirm uninstall of selected modules.
system_performance_settingsdrupal/modules/system/system.admin.incForm builder; Configure site performance settings.
system_rss_feeds_settingsdrupal/modules/system/system.admin.incForm builder; Configure how the site handles RSS feeds.
system_settings_formdrupal/modules/system/system.moduleAdd default buttons to a form and set its prefix.
system_site_information_settingsdrupal/modules/system/system.admin.incForm builder; The general site information form.
system_site_maintenance_settingsdrupal/modules/system/system.admin.incForm builder; Configure the site's maintenance status.
system_themes_formdrupal/modules/system/system.admin.incMenu callback; displays a listing of all themes.
system_theme_settingsdrupal/modules/system/system.admin.incForm builder; display theme configuration for entire site and individual themes.
taxonomy_form_termdrupal/modules/taxonomy/taxonomy.admin.incForm function for the term edit form.
taxonomy_form_vocabularydrupal/modules/taxonomy/taxonomy.admin.incDisplay form for adding and editing vocabularies.
taxonomy_overview_termsdrupal/modules/taxonomy/taxonomy.admin.incForm builder for the taxonomy terms overview.
taxonomy_overview_vocabulariesdrupal/modules/taxonomy/taxonomy.admin.incForm builder to list and manage vocabularies.
taxonomy_term_confirm_deletedrupal/modules/taxonomy/taxonomy.admin.incForm builder for the term delete form.
taxonomy_term_confirm_parentsdrupal/modules/taxonomy/taxonomy.admin.incForm builder for the confirmation of multiple term parents.
taxonomy_vocabulary_confirm_deletedrupal/modules/taxonomy/taxonomy.admin.incForm builder for the vocabulary delete confirmation form.
taxonomy_vocabulary_confirm_reset_alphabeticaldrupal/modules/taxonomy/taxonomy.admin.incForm builder to confirm reseting a vocabulary to alphabetical order.
theme_scaffolding_example_overview_formcontributions/docs/developer/examples/scaffolding_example/scaffolding_example.admin.incTheme the drag-and-drop overview form.
trigger_unassigndrupal/modules/trigger/trigger.admin.incConfirm removal of an assigned action.
user_admin_accountdrupal/modules/user/user.admin.incForm builder; User administration page.
user_admin_permdrupal/modules/user/user.admin.incMenu callback: administer permissions.
user_admin_roledrupal/modules/user/user.admin.incMenu callback: administer roles.
user_admin_settingsdrupal/modules/user/user.admin.incForm builder; Configure user settings for this site.
user_confirm_deletedrupal/modules/user/user.pages.incForm builder; confirm form for user deletion.
user_editdrupal/modules/user/user.pages.incForm builder; Present the form to edit a given user or profile category.
user_filter_formdrupal/modules/user/user.admin.incForm builder; Return form for user administration filters.
user_logindrupal/modules/user/user.moduleForm builder; the main user login form.
user_passdrupal/modules/user/user.pages.incForm builder; Request a password reset.
user_profile_formdrupal/modules/user/user.pages.incForm builder; edit a user account or one of their profile categories.
user_registerdrupal/modules/user/user.moduleForm builder; The user registration form.
_scaffolding_example_overview_record_fieldcontributions/docs/developer/examples/scaffolding_example/scaffolding_example.admin.incBuilds the fields for a single record on the drag-and-drop overview form.