Form builder functions

  1. drupal
    1. 6 includes/form.inc
    2. 7 includes/form.inc
    3. 8 core/includes/form.inc

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 & methods

NameDescription
aggregator_admin_formForm constructor for the aggregator system settings.
aggregator_categorize_itemsForm constructor to build the page list form.
aggregator_form_categoryForm constructor to add/edit/delete aggregator categories.
aggregator_form_feedForm constructor for adding and editing feed sources.
aggregator_form_opmlForm constructor for importing feeds from OPML.
aggregator_page_categoryForm constructor to list items aggregated in a category.
aggregator_page_category_formForm constructor to list items aggregated in a category.
aggregator_page_source_formForm constructor to show all items captured from a feed.
authorize_filetransfer_formForm constructor for the file transfer authorization form.
block_add_block_formForm constructor for the add block form.
block_admin_configureForm constructor for the block configuration form.
block_admin_display_formForm constructor for the main block administration form.
block_custom_block_formForm constructor for the custom block form.
book_admin_editForm constructor for administering a single book's hierarchy.
book_admin_settingsForm constructor for the book settings form.
book_outline_formForm constructor for the book outline form.
book_remove_formForm constructor to confirm removal of a node from a book.
color_scheme_formForm constructor for the color configuration form for a particular theme.
comment_admin_overviewForm constructor for the comment overview administration form.
comment_confirm_deleteForm constructor for the confirmation form for comment deletion.
comment_formForm constructor for the basic commenting form.
comment_multiple_delete_confirmForm constructor for the confirmation form for bulk comment deletion.
comment_unpublish_by_keyword_action_formForm constructor for the blacklisted keywords form.
contact_category_edit_formForm constructor for the category edit form.
contact_personal_formForm constructor for the personal contact form.
contact_site_formForm constructor for the site-wide contact form.
dblog_clear_log_formReturn form for dblog clear button.
dblog_filter_formReturn form for dblog administration filters.
field_ui_display_overview_formForm constructor for the field display settings for a given view mode.
field_ui_field_delete_formForm constructor for removing a field instance from a bundle.
field_ui_field_edit_formForm constructor for the field instance settings form.
field_ui_field_overview_formForm constructor for the 'Manage fields' form of a bundle.
field_ui_widget_type_formForm constructor for the widget selection form.
file_module_test_formForm constructor for testing a 'managed_file' element.
filter_admin_disableMenu callback; confirm deletion of a format.
filter_admin_format_formGenerate a text format form.
filter_admin_overviewMenu callback; Displays a list of all text formats and allows them to be rearranged.
form_test_emailForm constructor for testing #type 'email' elements.
form_test_rangeForm constructor for testing #type 'range' elements.
form_test_range_invalidForm constructor for testing invalid #type 'range' elements.
form_test_urlForm constructor for testing #type 'url' elements.
forum_form_containerReturns a form for adding a container to the forum vocabulary
forum_form_forumReturns a form for adding a forum to the forum vocabulary
image_effect_delete_formForm builder; Form for deleting an image effect.
image_effect_formForm builder; Form for adding and editing image effects.
image_style_add_formForm builder; Form for adding a new image style.
image_style_delete_formForm builder; Form for deleting an image style.
image_style_formForm builder; Edit an image style name and effects order.
locale_translate_delete_formUser interface for the string deletion confirmation screen.
locale_translate_edit_formUser interface for string editing.
locale_translation_filter_formReturn form for locale translation filters.
node_admin_nodesReturns the admin form object to node_admin_content().
node_assign_owner_action_formForm constructor for the settings form for node_assign_owner_action().
node_filter_formReturns the node administration filters form object to node_admin_content().
node_formForm constructor for the node add/edit form.
node_type_formForm constructor for the node type editing form.
openid_user_addForm builder; Add an OpenID identity.
path_admin_filter_formForm constructor for the path admin overview filter form.
path_admin_formForm constructor for the path administration form.
poll_cancel_formBuilds the cancel form for a poll.
poll_view_votingGenerates the voting form for a poll.
search_admin_settingsMenu callback: displays the search module settings page.
search_boxForm builder; Output a search form for the search block's search box.
shortcut_link_addForm callback: builds the form for adding a new shortcut link.
shortcut_link_deleteForm callback: builds the confirmation form for deleting a shortcut link.
shortcut_link_editForm callback: builds the form for editing a shortcut link.
shortcut_set_add_formForm callback: builds the form for adding a shortcut set.
shortcut_set_customizeForm callback: builds the form for customizing shortcut sets.
shortcut_set_delete_formForm callback: builds the confirmation form for deleting a shortcut set.
shortcut_set_edit_formForm callback: builds the form for editing the shortcut set name.
shortcut_set_switchForm callback: builds the form for switching shortcut sets.
simpletest_settings_formProvides settings form for SimpleTest variables.
statistics_settings_formForm constructor for the statistics administration form.
system_actions_delete_formCreate the form for confirmation of deleting an action.
system_actions_manage_formDefine the form for the actions overview page.
system_add_date_format_type_formAdd new date type.
system_clear_cache_submitSubmit callback; clear system caches.
system_clear_page_cache_submitSubmit callback; clear the page cache.
system_cron_settingsForm builder; Cron form.
system_date_time_settingsForm builder; Configure the site date and time settings.
system_file_system_settingsForm builder; Configure the site file handling.
system_image_toolkit_settingsForm builder; Configure site image toolkit usage.
system_ip_blocking_formDefine the form for blocking IP addresses.
system_logging_settingsForm builder; Configure error reporting settings.
system_modulesMenu callback; provides module enable/disable interface.
system_modules_confirm_formDisplay confirmation form for required modules.
system_modules_uninstallBuilds a form of currently disabled modules.
system_modules_uninstall_confirm_formConfirm uninstall of selected modules.
system_performance_settingsForm builder; Configure site performance settings.
system_performance_settings_submitForm submission handler for system_performance_settings().
system_regional_settingsForm builder; Configure the site regional settings.
system_rss_feeds_settingsForm builder; Configure how the site handles RSS feeds.
system_run_cron_submitSubmit callback; run cron.
system_settings_formAdd default buttons to a form and set its prefix.
system_site_information_settingsForm builder; The general site information form.
system_site_maintenance_modeForm builder; Configure the site's maintenance status.
system_themes_admin_formForm to select the administration theme.
system_theme_settingsForm builder; display theme configuration for entire site and individual themes.
taxonomy_form_termForm function for the term edit form.
taxonomy_form_vocabularyForm builder for the vocabulary editing form.
taxonomy_overview_termsForm builder for the taxonomy terms overview.
taxonomy_overview_vocabulariesForm builder to list and manage vocabularies.
taxonomy_term_confirm_deleteForm builder for the term delete form.
taxonomy_vocabulary_confirm_deleteForm builder for the vocabulary delete confirmation form.
taxonomy_vocabulary_confirm_reset_alphabeticalForm builder to confirm resetting a vocabulary to alphabetical order.
user_admin_accountForm builder; User administration page.
user_admin_permissionsMenu callback: administer permissions.
user_admin_roleForm to configure a single role.
user_admin_rolesForm to re-order roles or add a new one.
user_admin_settingsForm builder; Configure user settings for this site.
user_cancel_confirm_formForm builder; confirm form for cancelling user account.
user_filter_formForm builder; Return form for user administration filters.
user_loginForm builder; the main user login form.
user_passForm builder; Request a password reset.
user_profile_formForm builder; edit a user account.
user_register_formForm builder; the user registration form.

File

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

Login or register to post comments