Form builder functions


Functions

 aggregator_form_feed (&$form_state, $edit=array('refresh'=> 900, 'title'=> '', 'url'=> '', 'fid'=> NULL))
 aggregator_admin_settings ()
 aggregator_form_category (&$form_state, $edit=array('title'=> '', 'description'=> '', 'cid'=> NULL))
 aggregator_categorize_items ($items, $feed_source= '')
 book_admin_settings ()
 book_admin_edit ($form_state, $node)
 book_outline_form (&$form_state, $node)
 book_remove_form (&$form_state, $node)
 comment_admin_overview ($type= 'new', $arg)
 comment_multiple_delete_confirm (&$form_state)
 comment_confirm_delete (&$form_state, $comment)
 comment_edit ($cid)
 dblog_admin_settings ()
 dblog_filter_form ()
 filter_admin_overview ()
 filter_admin_format_form (&$form_state, $format)
 filter_admin_delete ()
 filter_admin_configure (&$form_state, $format)
 filter_admin_order (&$form_state, $format=NULL)
 forum_form_forum (&$form_state, $edit=array())
 forum_form_container (&$form_state, $edit=array())
 openid_user_add ()
 path_admin_form (&$form_state, $edit=array('src'=> '', 'dst'=> '', 'language'=> '', 'pid'=> NULL))
 path_admin_filter_form (&$form_state, $keys= '')
 profile_admin_overview ()
 profile_field_form (&$form_state, $arg=NULL)
 search_admin_settings ()
 statistics_access_logging_settings ()
 system_admin_theme_settings ()
 system_themes_form ()
 system_theme_settings (&$form_state, $key= '')
 system_modules ($form_state=array())
 system_modules_disable ($form, $edit)
 system_modules_confirm_form ($modules, $storage)
 system_modules_uninstall ($form_state=NULL)
 system_modules_uninstall_confirm_form ($storage)
 system_ip_blocking_form ($form_state)
 system_site_information_settings ()
 system_error_reporting_settings ()
 system_performance_settings ()
 system_clear_cache_submit (&$form_state, $form)
 system_file_system_settings ()
 system_image_toolkit_settings ()
 system_rss_feeds_settings ()
 system_date_time_settings ()
 system_site_maintenance_settings ()
 system_clean_url_settings ()
 taxonomy_overview_vocabularies ()
 taxonomy_form_vocabulary (&$form_state, $edit=array())
 taxonomy_overview_terms (&$form_state, $vocabulary)
 taxonomy_form_term (&$form_state, $vocabulary, $edit=array())
 taxonomy_term_confirm_parents (&$form_state, $vocabulary)
 taxonomy_term_confirm_delete (&$form_state, $tid)
 taxonomy_vocabulary_confirm_delete (&$form_state, $vid)
 taxonomy_vocabulary_confirm_reset_alphabetical (&$form_state, $vid)
 trigger_unassign ($form_state, $hook=NULL, $op=NULL, $aid=NULL)
 user_filter_form ()
 user_admin_account ()
 user_admin_settings ()
 user_admin_perm ($form_state, $rid=NULL)
 user_admin_role ()
 user_pass ()
 user_edit ($account, $category= 'account')
 user_profile_form ($form_state, $account, $category= 'account')
 user_confirm_delete (&$form_state, $account)

Detailed Description

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


Function Documentation

aggregator_admin_settings (  ) 

Form builder; Configure the aggregator system.

See also:
system_settings_form()

Definition at line 233 of file aggregator.admin.inc.

References drupal_map_assoc(), t(), url(), and variable_get().

Here is the call graph for this function:

aggregator_categorize_items ( items,
feed_source = '' 
)

Form builder; build the page list form.

Parameters:
$items An array of the feed items.
$feed_source The feed source URL.
Returns:
The form structure.
See also:
aggregator_categorize_items_validate()

aggregator_categorize_items_submit()

Definition at line 146 of file aggregator.pages.inc.

References check_plain(), db_fetch_object(), db_query(), t(), theme(), and variable_get().

Referenced by _aggregator_page_list().

Here is the call graph for this function:

aggregator_form_category ( &$  form_state,
edit = array('title' => '', 'description' => '', 'cid' => NULL) 
)

Form builder; Generate a form to add/edit/delete aggregator categories.

See also:
aggregator_form_category_validate()

aggregator_form_category_submit()

Definition at line 271 of file aggregator.admin.inc.

References t().

Here is the call graph for this function:

aggregator_form_feed ( &$  form_state,
edit = array('refresh' => 900, 'title' => '', 'url' => '', 'fid' => NULL) 
)

Form builder; Generate a form to add/edit feed sources.

See also:
aggregator_form_feed_validate()

aggregator_form_feed_submit()

Definition at line 55 of file aggregator.admin.inc.

References check_plain(), db_fetch_object(), db_query(), drupal_map_assoc(), t(), and url().

Here is the call graph for this function:

book_admin_edit ( form_state,
node 
)

Build the form to administrate the hierarchy of a single book.

See also:
book_admin_edit_submit()

Definition at line 72 of file book.admin.inc.

References _book_admin_table(), check_plain(), drupal_set_title(), and t().

Here is the call graph for this function:

book_admin_settings (  ) 

Builds and returns the book settings form.

See also:
book_admin_settings_validate()

Definition at line 29 of file book.admin.inc.

References t(), and variable_get().

Here is the call graph for this function:

book_outline_form ( &$  form_state,
node 
)

Build the form to handle all book outline operations via the outline tab.

See also:
book_outline_form_submit()

book_remove_button_submit()

Definition at line 105 of file book.pages.inc.

References nid, and t().

Here is the call graph for this function:

book_remove_form ( &$  form_state,
node 
)

Menu callback; builds a form to confirm removal of a node from the book.

See also:
book_remove_form_submit()

Definition at line 189 of file book.pages.inc.

References $title, nid, and t().

Here is the call graph for this function:

comment_admin_overview ( type = 'new',
arg 
)

Form builder; Builds the comment overview form for the admin.

Parameters:
$type Not used.
$arg Current path's fourth component deciding the form type (Published comments/Approval queue).
Returns:
The form structure.
See also:
comment_admin_overview_validate()

comment_admin_overview_submit()

theme_comment_admin_overview()

Definition at line 37 of file comment.admin.inc.

References $result, $status, $value, db_fetch_object(), drupal_get_destination(), format_date(), l(), nid, pager_query(), subject, t(), tablesort_sql(), theme(), and truncate_utf8().

Here is the call graph for this function:

comment_confirm_delete ( &$  form_state,
comment 
)

Form builder; Builds the confirmation form for deleting a single comment.

See also:
comment_confirm_delete_submit()

Definition at line 267 of file comment.admin.inc.

References nid, subject, and t().

Here is the call graph for this function:

comment_edit ( cid  ) 

Form builder; generate a comment editing form.

Parameters:
$cid ID of the comment to be edited.

Definition at line 16 of file comment.pages.inc.

References db_fetch_object(), db_query(), drupal_access_denied(), and drupal_unpack().

Here is the call graph for this function:

comment_multiple_delete_confirm ( &$  form_state  ) 

List the selected comments and verify that the admin wants to delete them.

Parameters:
$form_state An associative array containing the current state of the form.
Returns:
TRUE if the comments should be deleted, FALSE otherwise.
See also:
comment_multiple_delete_confirm_submit()

Definition at line 191 of file comment.admin.inc.

References $value, check_plain(), db_query(), db_result(), drupal_goto(), drupal_set_message(), and t().

Here is the call graph for this function:

dblog_admin_settings (  ) 

dblog module settings form.

See also:
system_settings_form()

Definition at line 15 of file dblog.admin.inc.

References drupal_map_assoc(), t(), url(), and variable_get().

Here is the call graph for this function:

dblog_filter_form (  ) 

Return form for dblog administration filters.

See also:
dblog_filter_form_submit()

dblog_filter_form_validate()

Definition at line 253 of file dblog.admin.inc.

References dblog_filters(), and t().

Here is the call graph for this function:

filter_admin_configure ( &$  form_state,
format 
)

Build a form to change the settings for a format's filters.

Definition at line 314 of file filter.admin.inc.

References delta, module, module_invoke(), and t().

Here is the call graph for this function:

filter_admin_delete (  ) 

Menu callback; confirm deletion of a format.

See also:
filter_admin_delete_submit()

Definition at line 259 of file filter.admin.inc.

References arg(), db_fetch_object(), db_query(), drupal_goto(), drupal_not_found(), drupal_set_message(), name, t(), and variable_get().

Here is the call graph for this function:

filter_admin_format_form ( &$  form_state,
format 
)

Generate a filter format form.

See also:
filter_admin_format_form_validate()

filter_admin_format_form_submit()

Definition at line 110 of file filter.admin.inc.

References $name, delta, l(), module, module_invoke(), name, t(), theme(), and variable_get().

Here is the call graph for this function:

filter_admin_order ( &$  form_state,
format = NULL 
)

Build the form for ordering filters for a format.

See also:
theme_filter_admin_order()

filter_admin_order_submit()

Definition at line 357 of file filter.admin.inc.

References name, and t().

Here is the call graph for this function:

filter_admin_overview (  ) 

Menu callback; Displays a list of all input formats and which one is the default.

See also:
filter_admin_overview_submit()

Definition at line 16 of file filter.admin.inc.

References $name, l(), name, t(), and variable_get().

Here is the call graph for this function:

forum_form_container ( &$  form_state,
edit = array() 
)

Returns a form for adding a container to the forum vocabulary

Parameters:
$edit Associative array containing a container term to be added or edited.
See also:
forum_form_submit()

Definition at line 107 of file forum.admin.inc.

References _forum_parent_select(), t(), and variable_get().

Here is the call graph for this function:

forum_form_forum ( &$  form_state,
edit = array() 
)

Returns a form for adding a forum to the forum vocabulary

Parameters:
$edit Associative array containing a forum term to be added or edited.
See also:
forum_form_submit()

Definition at line 30 of file forum.admin.inc.

References _forum_parent_select(), t(), and variable_get().

Here is the call graph for this function:

openid_user_add (  ) 

Form builder; Add an OpenID identity.

See also:
openid_user_add_validate()

Definition at line 61 of file openid.pages.inc.

References t().

Here is the call graph for this function:

path_admin_filter_form ( &$  form_state,
keys = '' 
)

Return a form to filter URL aliases.

See also:
path_admin_filter_form_submit()

Definition at line 191 of file path.admin.inc.

References t().

Here is the call graph for this function:

path_admin_form ( &$  form_state,
edit = array('src' => '', 'dst' => '', 'language' => '', 'pid' => NULL) 
)

Return a form for editing or creating an individual URL alias.

See also:
path_admin_form_validate()

path_admin_form_submit()

Definition at line 87 of file path.admin.inc.

References t(), url(), and variable_get().

Here is the call graph for this function:

profile_admin_overview (  ) 

Form builder to display a listing of all editable profile fields.

See also:
profile_admin_overview_submit()

Definition at line 15 of file profile.admin.inc.

References $result, $value, check_plain(), db_fetch_object(), db_query(), l(), name, and t().

Here is the call graph for this function:

profile_field_form ( &$  form_state,
arg = NULL 
)

Menu callback: Generate a form to add/edit a user profile field.

See also:
profile_field_form_validate()

profile_field_form_submit()

Definition at line 167 of file profile.admin.inc.

References $type, arg(), db_fetch_array(), db_query(), drupal_not_found(), drupal_set_title(), and t().

Here is the call graph for this function:

search_admin_settings (  ) 

Menu callback; displays the search module settings page.

See also:
system_settings_form()

search_admin_settings_validate()

Definition at line 36 of file search.admin.inc.

References $percentage, $status, drupal_map_assoc(), format_plural(), module_hook(), module_invoke(), module_invoke_all(), module_list(), t(), url(), and variable_get().

Here is the call graph for this function:

statistics_access_logging_settings (  ) 

Form builder; Configure access logging.

See also:
system_settings_form()

Definition at line 183 of file statistics.admin.inc.

References drupal_map_assoc(), t(), url(), and variable_get().

Here is the call graph for this function:

system_admin_theme_settings (  ) 

Form builder; This function allows selection of the theme to show in administration sections.

See also:
system_settings_form()

Definition at line 141 of file system.admin.inc.

References t(), and variable_get().

Here is the call graph for this function:

system_clean_url_settings (  ) 

Form builder; Configure Clean URL settings.

See also:
system_settings_form()

Definition at line 1722 of file system.admin.inc.

References base_path(), drupal_add_js(), drupal_get_path(), request_uri(), t(), and variable_get().

Here is the call graph for this function:

system_clear_cache_submit ( &$  form_state,
form 
)

Submit callback; clear system caches.

Definition at line 1424 of file system.admin.inc.

References drupal_flush_all_caches(), drupal_set_message(), and t().

Here is the call graph for this function:

system_date_time_settings (  ) 

Form builder; Configure the site date and time settings.

See also:
system_settings_form()

system_date_time_settings_submit()

Definition at line 1524 of file system.admin.inc.

References drupal_add_js(), drupal_get_path(), format_date(), t(), url(), and variable_get().

Here is the call graph for this function:

system_error_reporting_settings (  ) 

Form builder; Configure error reporting settings.

See also:
system_settings_form()

Definition at line 1270 of file system.admin.inc.

References t(), url(), and variable_get().

Here is the call graph for this function:

system_file_system_settings (  ) 

Form builder; Configure the site file handling.

See also:
system_settings_form()

Definition at line 1435 of file system.admin.inc.

References file_directory_path(), file_directory_temp(), t(), and variable_get().

Here is the call graph for this function:

system_image_toolkit_settings (  ) 

Form builder; Configure site image toolkit usage.

See also:
system_settings_form()

Definition at line 1472 of file system.admin.inc.

References image_get_available_toolkits(), image_get_toolkit(), image_toolkit_invoke(), t(), variable_get(), and variable_set().

Here is the call graph for this function:

system_ip_blocking_form ( form_state  ) 

Define the form for blocking IP addresses.

See also:
system_ip_blocking_form_validate()

system_ip_blocking_form_submit()

Definition at line 1121 of file system.admin.inc.

References arg(), and t().

Here is the call graph for this function:

system_modules ( form_state = array()  ) 

Menu callback; provides module enable/disable interface.

The list of modules gets populated by module.info files, which contain each module's name, description and dependencies.

See also:
drupal_parse_info_file for information on module.info descriptors.
Dependency checking is performed to ensure that a module cannot be enabled if the module has disabled dependencies and also to ensure that the module cannot be disabled if the module has enabled dependents.

Parameters:
$form_state An associative array containing the current state of the form.
See also:
theme_system_modules()

system_modules_submit()

Returns:
The form array.

Definition at line 607 of file system.admin.inc.

References $status, _system_is_incompatible(), cache_clear_all(), drupal_help_arg(), drupal_rebuild_theme_registry(), drupal_required_modules(), drupal_ucfirst(), menu_rebuild(), module_exists(), module_hook(), module_invoke(), module_rebuild_cache(), system_modules_confirm_form(), t(), theme(), and url().

Here is the call graph for this function:

system_modules_confirm_form ( modules,
storage 
)

Display confirmation form for dependencies.

Parameters:
$modules Array of module file objects as returned from module_rebuild_cache().
$storage The contents of $form_state['storage']; an array with two elements: the list of dependencies and the list of status form field values from the previous screen.

Definition at line 790 of file system.admin.inc.

References $name, $status, drupal_ucfirst(), format_plural(), t(), and theme().

Referenced by system_modules().

Here is the call graph for this function:

system_modules_disable ( form,
edit 
)

Form process callback function to disable check boxes.

Parameters:
$form The form structure.
$edit Not used.
Returns:
The form structure.

Definition at line 772 of file system.admin.inc.

system_modules_uninstall ( form_state = NULL  ) 

Uninstall functions Builds a form of currently disabled modules.

See also:
system_modules_uninstall_validate()

system_modules_uninstall_submit()

Parameters:
$form_state['values'] Submitted form values.
Returns:
A form array representing the currently disabled modules.

Definition at line 972 of file system.admin.inc.

References db_fetch_object(), db_query(), module_hook(), module_load_install(), name, system_modules_uninstall_confirm_form(), t(), and url().

Here is the call graph for this function:

system_modules_uninstall_confirm_form ( storage  ) 

Confirm uninstall of selected modules.

Parameters:
$storage An associative array of modules selected to be uninstalled.
Returns:
A form array representing modules to confirm.

Definition at line 1028 of file system.admin.inc.

References $value, drupal_get_filename(), drupal_parse_info_file(), t(), and theme().

Referenced by system_modules_uninstall().

Here is the call graph for this function:

system_performance_settings (  ) 

Form builder; Configure site performance settings.

See also:
system_settings_form()

Definition at line 1317 of file system.admin.inc.

References drupal_map_assoc(), file_directory_path(), module_implements(), t(), and variable_get().

Here is the call graph for this function:

system_rss_feeds_settings (  ) 

Form builder; Configure how the site handles RSS feeds.

See also:
system_settings_form()

Definition at line 1497 of file system.admin.inc.

References drupal_map_assoc(), t(), and variable_get().

Here is the call graph for this function:

system_site_information_settings (  ) 

Form builder; The general site information form.

See also:
system_settings_form()

Definition at line 1190 of file system.admin.inc.

References t(), url(), and variable_get().

Here is the call graph for this function:

system_site_maintenance_settings (  ) 

Form builder; Configure the site's maintenance status.

See also:
system_settings_form()

Definition at line 1696 of file system.admin.inc.

References t(), url(), and variable_get().

Here is the call graph for this function:

system_theme_settings ( &$  form_state,
key = '' 
)

Form builder; display theme configuration for entire site and individual themes.

Parameters:
$key A theme name.
Returns:
The form structure.
See also:
system_theme_settings_submit()

Definition at line 315 of file system.admin.inc.

References $name, $title, $type, check_plain(), element_children(), file_check_directory(), file_copy(), file_directory_path(), file_save_upload(), module_exists(), t(), theme_get_settings(), and variable_get().

Here is the call graph for this function:

system_themes_form (  ) 

Menu callback; displays a listing of all themes.

See also:
system_themes_form_submit()

Definition at line 176 of file system.admin.inc.

References $status, drupal_clear_css_cache(), drupal_map_assoc(), l(), name, t(), theme(), and variable_get().

Here is the call graph for this function:

taxonomy_form_term ( &$  form_state,
vocabulary,
edit = array() 
)

Form function for the term edit form.

See also:
taxonomy_form_term_submit()

Definition at line 641 of file taxonomy.admin.inc.

References $children, drupal_map_assoc(), t(), taxonomy_term_confirm_delete(), taxonomy_term_confirm_parents(), and variable_get().

Here is the call graph for this function:

taxonomy_form_vocabulary ( &$  form_state,
edit = array() 
)

Display form for adding and editing vocabularies.

See also:
taxonomy_form_vocabulary_submit()

Definition at line 103 of file taxonomy.admin.inc.

References t(), and taxonomy_vocabulary_confirm_delete().

Here is the call graph for this function:

taxonomy_overview_terms ( &$  form_state,
vocabulary 
)

Form builder for the taxonomy terms overview.

Display a tree of all the terms in a vocabulary, with options to edit each one. The form is made drag and drop by the theme function.

See also:
taxonomy_overview_terms_submit()

theme_taxonomy_overview_terms()

Definition at line 253 of file taxonomy.admin.inc.

References $results, db_fetch_object(), db_query(), db_rewrite_sql(), drupal_get_destination(), drupal_set_title(), l(), name, pager_query(), t(), and taxonomy_vocabulary_confirm_reset_alphabetical().

Referenced by forum_overview().

Here is the call graph for this function:

taxonomy_overview_vocabularies (  ) 

Form builder to list and manage vocabularies.

See also:
taxonomy_overview_vocabularies_submit()

theme_taxonomy_overview_vocabularies()

Definition at line 16 of file taxonomy.admin.inc.

References $type, check_plain(), l(), name, and t().

Here is the call graph for this function:

taxonomy_term_confirm_delete ( &$  form_state,
tid 
)

Form builder for the term delete form.

See also:
taxonomy_term_confirm_delete_submit()

Definition at line 837 of file taxonomy.admin.inc.

References name, and t().

Referenced by taxonomy_form_term().

Here is the call graph for this function:

taxonomy_term_confirm_parents ( &$  form_state,
vocabulary 
)

Form builder for the confirmation of multiple term parents.

See also:
taxonomy_form_term()

Definition at line 817 of file taxonomy.admin.inc.

References drupal_get_destination(), element_children(), name, and t().

Referenced by taxonomy_form_term().

Here is the call graph for this function:

taxonomy_vocabulary_confirm_delete ( &$  form_state,
vid 
)

Form builder for the vocabulary delete confirmation form.

See also:
taxonomy_vocabulary_confirm_delete_submit()

Definition at line 873 of file taxonomy.admin.inc.

References name, and t().

Referenced by taxonomy_form_vocabulary().

Here is the call graph for this function:

taxonomy_vocabulary_confirm_reset_alphabetical ( &$  form_state,
vid 
)

Form builder to confirm reseting a vocabulary to alphabetical order.

See also:
taxonomy_vocabulary_confirm_reset_alphabetical_submit()

Definition at line 909 of file taxonomy.admin.inc.

References name, and t().

Referenced by taxonomy_overview_terms().

Here is the call graph for this function:

trigger_unassign ( form_state,
hook = NULL,
op = NULL,
aid = NULL 
)

Confirm removal of an assigned action.

Parameters:
$hook 
$op 
$aid The action ID.
See also:
trigger_unassign_submit()

Definition at line 50 of file trigger.admin.inc.

References $op, actions_function_lookup(), actions_get_all_actions(), drupal_goto(), and t().

Here is the call graph for this function:

user_admin_account (  ) 

Form builder; User administration page.

See also:
user_admin_account_validate()

user_admin_account_submit()

Definition at line 129 of file user.admin.inc.

References $header, $result, $status, db_fetch_object(), db_query(), drupal_get_destination(), format_interval(), l(), module_invoke_all(), pager_query(), t(), tablesort_sql(), and theme().

Here is the call graph for this function:

user_admin_perm ( form_state,
rid = NULL 
)

Menu callback: administer permissions.

See also:
user_admin_perm_submit()

theme_user_admin_perm()

Definition at line 495 of file user.admin.inc.

References $name, $status, module_invoke(), module_list(), and t().

Here is the call graph for this function:

user_admin_role (  ) 

Menu callback: administer roles.

See also:
user_admin_role_validate()

user_admin_role_submit()

theme_user_admin_new_role()

Definition at line 622 of file user.admin.inc.

References arg(), db_fetch_object(), db_query(), drupal_goto(), name, and t().

Here is the call graph for this function:

user_admin_settings (  ) 

Form builder; Configure user settings for this site.

See also:
system_settings_form()

Definition at line 231 of file user.admin.inc.

References drupal_add_js(), drupal_get_path(), file_check_directory(), file_create_path(), file_directory_path(), t(), and variable_get().

Here is the call graph for this function:

user_confirm_delete ( &$  form_state,
account 
)

Form builder; confirm form for user deletion.

See also:
user_confirm_delete_submit()

Definition at line 303 of file user.pages.inc.

References name, and t().

Here is the call graph for this function:

user_edit ( account,
category = 'account' 
)

Form builder; Present the form to edit a given user or profile category.

See also:
user_edit_validate()

user_edit_submit()

Definition at line 220 of file user.pages.inc.

References check_plain(), drupal_get_form(), drupal_set_title(), and name.

Here is the call graph for this function:

user_filter_form (  ) 

Form builder; Return form for user administration filters.

See also:
user_filter_form_submit()

Definition at line 35 of file user.admin.inc.

References $type, $value, drupal_add_js(), and t().

Here is the call graph for this function:

user_pass (  ) 

Form builder; Request a password reset.

See also:
user_pass_validate()

user_pass_submit()

Definition at line 31 of file user.pages.inc.

References t().

Here is the call graph for this function:

user_profile_form ( form_state,
account,
category = 'account' 
)

Form builder; edit a user account or one of their profile categories.

See also:
user_profile_form_validate()

user_profile_form_submit()

user_edit_delete_submit()

Definition at line 233 of file user.pages.inc.

References t().

Here is the call graph for this function:


Generated on Mon Jun 2 15:08:46 2008 for SimpleTest by  1.5.5