Webform Module Hooks in Webform 7.4
Same name and namespace in other branches
- 6.3 webform.api.php \webform_hooks
- 7.3 webform.api.php \webform_hooks
Webform's hooks enable other modules to intercept events within Webform, such as the completion of a submission or adding validation. Webform's hooks also allow other modules to provide additional components for use within forms.
File
- ./
webform.api.php, line 8 - Sample hooks demonstrating usage in Webform.
Functions
Name![]() |
Location | Description |
---|---|---|
callback_webform_options |
./ |
Define a list of options that Webform may use in a select component. |
hook_webform_analysis_alter |
./ |
Alter the entire analysis before rendering to the page on the Analysis tab. |
hook_webform_analysis_component_data_alter |
./ |
Alter data when displaying an analysis on that component. |
hook_webform_component_defaults_alter |
./ |
Alter the list of Webform component default values. |
hook_webform_component_delete |
./ |
Respond to a Webform component being deleted. |
hook_webform_component_info |
./ |
Define components to Webform. |
hook_webform_component_info_alter |
./ |
Alter the list of available Webform components. |
hook_webform_component_insert |
./ |
Respond to a Webform component being inserted into the database. |
hook_webform_component_load |
./ |
Modify a loaded Webform component. |
hook_webform_component_presave |
./ |
Modify a Webform component before it is saved to the database. |
hook_webform_component_update |
./ |
Respond to a Webform component being updated in the database. |
hook_webform_csv_data_alter |
./ |
Alter a Webform submission's data when exported. |
hook_webform_csv_header_alter |
./ |
Alter a Webform submission's header when exported. |
hook_webform_download_sids_query_alter |
./ |
Alter the query that will produce the list of submission IDs to be downloaded. |
hook_webform_draft_alter |
./ |
Modify the draft to be presented for editing. |
hook_webform_node_defaults_alter |
./ |
Alter default settings for a newly created webform node. |
hook_webform_results_access |
./ |
Determine if a user has access to see the results of a webform. |
hook_webform_results_clear_access |
./ |
Determine if a user has access to clear the results of a webform. |
hook_webform_results_download_submission_information_data |
./ |
Return values for submission data download fields. |
hook_webform_results_download_submission_information_info |
./ |
Add additional fields to submission data downloads. |
hook_webform_results_download_submission_information_info_alter |
./ |
Alter fields in submission data downloads. |
hook_webform_select_options_info |
./ |
Define callbacks that can be used as select list options. |
hook_webform_select_options_info_alter |
./ |
Alter the list of select list options provided by Webform and other modules. |
hook_webform_submission_access |
./ |
Alter access to a Webform submission. |
hook_webform_submission_actions |
./ |
Provide a list of actions that can be executed on a submission. |
hook_webform_submission_create_alter |
./ |
Respond to the creation of a new submission from form values. |
hook_webform_submission_delete |
./ |
Respond to a Webform submission being deleted. |
hook_webform_submission_insert |
./ |
Respond to a Webform submission being inserted. |
hook_webform_submission_load |
./ |
Respond to the loading of Webform submissions. |
hook_webform_submission_presave |
./ |
Modify a Webform submission, prior to saving it in the database. |
hook_webform_submission_render_alter |
./ |
Alter the display of a Webform submission. |
hook_webform_submission_update |
./ |
Respond to a Webform submission being updated. |
hook_webform_update_access |
./ |
Overrides the node_access and user_access permissions. |
_webform_attachments_component |
./ |
Return an array of files associated with the component. |