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_settings | modules/aggregator/aggregator.admin.inc | Form builder; Configure the aggregator system. See alsosystem_settings_form() |
| aggregator_form_category | modules/aggregator/aggregator.admin.inc | Form builder; Generate a form to add/edit/delete aggregator categories. See alsoaggregator_form_category_validate() |
| aggregator_form_feed | modules/aggregator/aggregator.admin.inc | Form builder; Generate a form to add/edit feed sources. See alsoaggregator_form_feed_validate() |
| aggregator_form_opml | modules/aggregator/aggregator.admin.inc | Form builder; Generate a form to import feeds from OPML. See alsoaggregator_form_opml_validate() |
| book_admin_edit | modules/book/book.admin.inc | Build the form to administrate the hierarchy of a single book. See alsobook_admin_edit_submit() |
| book_admin_settings | modules/book/book.admin.inc | Builds and returns the book settings form. See alsobook_admin_settings_validate() |
| book_outline_form | modules/book/book.pages.inc | Build the form to handle all book outline operations via the outline tab. See alsobook_outline_form_submit() |
| book_remove_form | modules/book/book.pages.inc | Menu callback; builds a form to confirm removal of a node from the book. See alsobook_remove_form_submit() |
| comment_confirm_delete | modules/comment/comment.admin.inc | Form builder; Builds the confirmation form for deleting a single comment. See alsocomment_confirm_delete_submit() |
| comment_edit | modules/comment/comment.pages.inc | Form builder; generate a comment editing form. |
| comment_form | modules/comment/comment.module | Generate the basic commenting form, for appending to a node or display on a separate page. |
| comment_form_add_preview | modules/comment/comment.module | Form builder; Generate and validate a comment preview form. |
| 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_admin_settings | modules/dblog/dblog.admin.inc | dblog module settings form. See alsosystem_settings_form() |
| dblog_filter_form | modules/dblog/dblog.admin.inc | Return form for dblog administration filters. See alsodblog_filter_form_submit() |
| filter_admin_configure | modules/filter/filter.admin.inc | Build a form to change the settings for a format's filters. |
| filter_admin_delete | modules/filter/filter.admin.inc | Menu callback; confirm deletion of a format. See alsofilter_admin_delete_submit() |
| filter_admin_format_form | modules/filter/filter.admin.inc | Generate a filter format form. See alsofilter_admin_format_form_validate() |
| filter_admin_order | modules/filter/filter.admin.inc | Build the form for ordering filters for a format. See alsotheme_filter_admin_order() |
| filter_admin_overview | modules/filter/filter.admin.inc | Menu callback; Displays a list of all input formats and which one is the default. See alsofilter_admin_overview_submit() |
| filter_form | modules/filter/filter.module | Generate a selector for choosing a format in a form. See alsofilter_form_validate() |
| 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 |
| openid_user_add | modules/openid/openid.pages.inc | Form builder; Add an OpenID identity. See alsoopenid_user_add_validate() |
| path_admin_filter_form | modules/path/path.admin.inc | Return a form to filter URL aliases. See alsopath_admin_filter_form_submit() |
| path_admin_form | modules/path/path.admin.inc | Return a form for editing or creating an individual URL alias. See alsopath_admin_form_validate() |
| poll_cancel_form | modules/poll/poll.module | Builds the cancel form for a poll. See alsopoll_cancel() |
| poll_view_voting | modules/poll/poll.module | Generates the voting form for a poll. See alsopoll_vote() |
| profile_admin_overview | modules/profile/profile.admin.inc | Form builder to display a listing of all editable profile fields. See alsoprofile_admin_overview_submit() |
| profile_field_form | modules/profile/profile.admin.inc | Menu callback: Generate a form to add/edit a user profile field. See alsoprofile_field_form_validate() |
| scaffolding_example_delete_confirm | developer/examples/scaffolding_example/scaffolding_example.admin.inc | Build the delete confirmation form. |
| scaffolding_example_form | developer/examples/scaffolding_example/scaffolding_example.admin.inc | Build the record editing form. |
| scaffolding_example_overview_form | developer/examples/scaffolding_example/scaffolding_example.admin.inc | Build an overview form with drag and drop re-ordering of records. |
| search_admin_settings | modules/search/search.admin.inc | Menu callback; displays the search module settings page. See alsosystem_settings_form() |
| search_box | modules/search/search.module | Form builder; Output a search form for the search block and the theme's search box. See alsosearch_box_form_submit() |
| statistics_access_logging_settings | modules/statistics/statistics.admin.inc | Form builder; Configure access logging. See alsosystem_settings_form() |
| system_actions_delete_form | modules/system/system.module | Create the form for confirmation of deleting an action. See alsosystem_actions_delete_form_submit() |
| system_actions_manage_form | modules/system/system.module | Define the form for the actions overview page. See alsosystem_actions_manage_form_submit() |
| system_admin_theme_settings | modules/system/system.admin.inc | Form builder; This function allows selection of the theme to show in administration sections. See alsosystem_settings_form() |
| system_clean_url_settings | modules/system/system.admin.inc | Form builder; Configure Clean URL settings. See alsosystem_settings_form() |
| 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. See alsosystem_settings_form() |
| system_error_reporting_settings | modules/system/system.admin.inc | Form builder; Configure error reporting settings. See alsosystem_settings_form() |
| system_file_system_settings | modules/system/system.admin.inc | Form builder; Configure the site file handling. See alsosystem_settings_form() |
| system_image_toolkit_settings | modules/system/system.admin.inc | Form builder; Configure site image toolkit usage. See alsosystem_settings_form() |
| system_ip_blocking_form | modules/system/system.admin.inc | Define the form for blocking IP addresses. See alsosystem_ip_blocking_form_validate() |
| 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 dependencies. |
| system_modules_uninstall | modules/system/system.admin.inc | Builds a form of currently disabled modules. See alsosystem_modules_uninstall_validate() |
| 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. See alsosystem_settings_form() |
| system_rss_feeds_settings | modules/system/system.admin.inc | Form builder; Configure how the site handles RSS feeds. See alsosystem_settings_form() |
| system_settings_form | modules/system/system.module | Add default buttons to a form and set its prefix. See alsosystem_settings_form_submit() |
| system_site_information_settings | modules/system/system.admin.inc | Form builder; The general site information form. See alsosystem_settings_form() |
| system_site_maintenance_settings | modules/system/system.admin.inc | Form builder; Configure the site's maintenance status. See alsosystem_settings_form() |
| system_themes_form | modules/system/system.admin.inc | Menu callback; displays a listing of all themes. See alsosystem_themes_form_submit() |
| taxonomy_form_term | modules/taxonomy/taxonomy.admin.inc | Form function for the term edit form. See alsotaxonomy_form_term_submit() |
| taxonomy_form_vocabulary | modules/taxonomy/taxonomy.admin.inc | Display form for adding and editing vocabularies. See alsotaxonomy_form_vocabulary_submit() |
| 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. See alsotaxonomy_overview_vocabularies_submit() |
| taxonomy_term_confirm_delete | modules/taxonomy/taxonomy.admin.inc | Form builder for the term delete form. See alsotaxonomy_term_confirm_delete_submit() |
| taxonomy_term_confirm_parents | modules/taxonomy/taxonomy.admin.inc | Form builder for the confirmation of multiple term parents. See alsotaxonomy_form_term() |
| taxonomy_vocabulary_confirm_delete | modules/taxonomy/taxonomy.admin.inc | Form builder for the vocabulary delete confirmation form. See alsotaxonomy_vocabulary_confirm_delete_submit() |
| taxonomy_vocabulary_confirm_reset_alphabetical | modules/taxonomy/taxonomy.admin.inc | Form builder to confirm reseting a vocabulary to alphabetical order. See alsotaxonomy_vocabulary_confirm_reset_alphabetical_submit() |
| theme_scaffolding_example_overview_form | developer/examples/scaffolding_example/scaffolding_example.admin.inc | Theme the drag-and-drop overview form. |
| 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. See alsouser_admin_account_validate() |
| user_admin_perm | modules/user/user.admin.inc | Menu callback: administer permissions. See alsouser_admin_perm_submit() |
| user_admin_role | modules/user/user.admin.inc | Menu callback: administer roles. See alsouser_admin_role_validate() |
| user_admin_settings | modules/user/user.admin.inc | Form builder; Configure user settings for this site. See alsosystem_settings_form() |
| user_confirm_delete | modules/user/user.pages.inc | Form builder; confirm form for user deletion. See alsouser_confirm_delete_submit() |
| user_edit | modules/user/user.pages.inc | Form builder; Present the form to edit a given user or profile category. See alsouser_edit_validate() |
| user_filter_form | modules/user/user.admin.inc | Form builder; Return form for user administration filters. See alsouser_filter_form_submit() |
| 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. See alsouser_pass_validate() |
| user_profile_form | modules/user/user.pages.inc | Form builder; edit a user account or one of their profile categories. See alsouser_profile_form_validate() |
| user_register | modules/user/user.module | Form builder; The user registration form. See alsouser_register_validate() |
| _scaffolding_example_overview_record_field | developer/examples/scaffolding_example/scaffolding_example.admin.inc | Builds the fields for a single record on the drag-and-drop overview form. |