Template Hooks
Module Development
This page lists all template hooks available in the default templates. Since theme template names are quite fluid - theme designers can create new templates with whatever names they want - the following list is based on the default template. It actually doesn't matter what the files are called; just so long as the "location" attribute of the template_hook smarty function call has the value determined below, any assigned module functions will get called.
When looking for a template function, it's generally the best idea to go looking directly in the templates to see what hooks are available. Still, this page is provided as a reference.
| Template | Notes | Hooks |
|---|---|---|
| /admin/clients/tab_main.tpl | These hooks appear at various places within the main edit client page for the administrator. |
admin_edit_client_main_top admin_edit_client_main_middle admin_edit_client_main_bottom |
| /admin/clients/tab_settings.tpl | These hooks appear at various places within the edit client settings page for the administrator. |
admin_edit_client_settings_top admin_edit_client_settings_bottom |
| /admin/clients/tab_forms.tpl | This is the administrator's edit client » forms tab, which lists the tabs and Views that the client has access to. |
admin_edit_client_forms_top admin_edit_client_forms_bottom |
| /admin/clients/add.tpl | The Add Client page. |
admin_add_client_top admin_add_client_bottom |
| /admin/clients/index.tpl | The list clients page. |
admin_list_clients_top admin_list_clients_bottom |
| /admin/clients/edit.tpl | These hooks appear on ALL the Edit client pages, regardless of tab. They are positioned above and below the tabsets. |
admin_edit_client_pages_top admin_edit_client_pages_bottom |
| /admin/forms/tab_edit_email_tab1.tpl | The first of the edit email tabs. |
edit_template_tab1 edit_template_tab1_advanced |
| /admin/forms/tab_edit_email_tab2.tpl | The second of the edit email tabs. | edit_template_tab2 |
| /admin/forms/submissions.tpl | The submission listing page for the administrator account. |
admin_submission_listings_buttons1 admin_submission_listings_buttons2 admin_submission_listings_buttons3 admin_submission_listings_buttons4 admin_submission_listings_top admin_submission_listings_bottom |
| /clients/forms/index.tpl | The submission listing page for client accounts. |
client_submission_listings_buttons1 client_submission_listings_buttons2 client_submission_listings_buttons3 client_submission_listings_buttons4 client_submission_listings_top client_submission_listings_bottom |
| /admin/account/index.tpl | These hooks appear at the top and bottom of the edit administrator account page. |
admin_account_top admin_account_bottom |
| /admin/settings/tab_main.tpl | The Settings » Main tab | admin_settings_main_tab_bottom |
| /admin/settings/tab_accounts.tpl | The Settings » Accounts tab | admin_settings_client_settings_bottom |
| /admin/settings/tab_files.tpl | The Settings » Files tab | admin_settings_files_bottom |
| /admin/settings/tab_wysiwyg.tpl | The Settings » WYSIWYG tab | admin_settings_wysiwyg_bottom |
| /admin/settings/tab_themes.tpl | The Settings » Themes tab | admin_settings_themes_bottom |
| /admin/settings/tab_menus.tpl | The Settings » Menus tab | admin_settings_menus_top |
| /admin/settings/tab_edit_admin_menu.tpl | The edit admin menu page | admin_settings_admin_menu_top |
| /admin/settings/tab_edit_client_menu.tpl | The edit client menu page | admin_settings_admin_menu_top |