Indigo
Active member
As of 1.0.0 Beta 4, there are 9 template hooks within the codebase. This is a list of what they are, where they are, their parameters, and what they contain. Some have a quick explanation of how they can be used. I'll try to remember to keep this updated as new releases come out.
editor_js_setup
Template: editor_js_setup
Parameters
- editorId: The ID of the editor. For example, this area I'm using to write the thread is "ctrl_message"
Contains all the setup code for tinyMCE. Could theoretically be used to pass more options to tinyMCE, or change existing options, via regular expressions.
footer_links
Template: footer
Contains the HTML for the Contact Us/Home/Top links. Can be used to add more links/data or alter the links in that area.
footer_links_legal
Template: footer
Same as above, but for the Terms/Privacy Policy links that appear directly underneath the previous hook.
forum_list_sidebar
Template: forum_list
Contains the sidebar, basically. Note that this hook currently only works for the forum list's sidebar, not the one that appears on the recent activity page. There are some "sub hooks" in the form of HTML comments that can be hooked into.
<!-- block: sidebar_online_staff --> is before the Staff Online area.
<!-- block: sidebar_online_users --> is between staff online and normal members online.
<!-- block: forum_stats --> is between the online users and statistics.
<!-- end block: forum_stats --> is after the forum stats.
<!-- slot: forum_stats_extra --> is at the end of the statistics list, allowing you to add more stats.
message_user_info_avatar
Template: message_user_info
Parameters
- user: Information about the author of the message.
Contains the avatar holder div, and the avatar of the postbit. <!-- slot: message_user_info_avatar --> is within the avatar holder, after the avatar itself.
message_user_info_text
Template: message_user_info
Parameters
- user: Information about the author of the message.
Contains the username and user title part of the postbit. <!-- slot: message_user_info_text --> is within the <h3 class="userText">, after the user title.
message_user_info_extra
Template: message_user_info
Parameters
- user: Information about the author of the message.
Contains extra information in the postbit (if you have it configured to display), like the post count, number of likes, join date, etc. Could be used to add things like a "Points" field, arcade trophies, etc. to the postbit.
page_container_head
Template: PAGE_CONTAINER
Contains the full contents of the <head> tag. Can be used to add data to the <head> of all pages, or modify what is already there.
page_container_js_body
Template: page_container_js_body
Contains all the various "information passing" code for XenForo, like making options and phrases available to the JavaScript. Would generally be used for passing required JS information to your own addon (at least for what I intend to use it for).
editor_js_setup
Template: editor_js_setup
Parameters
- editorId: The ID of the editor. For example, this area I'm using to write the thread is "ctrl_message"
Contains all the setup code for tinyMCE. Could theoretically be used to pass more options to tinyMCE, or change existing options, via regular expressions.
footer_links
Template: footer
Contains the HTML for the Contact Us/Home/Top links. Can be used to add more links/data or alter the links in that area.
footer_links_legal
Template: footer
Same as above, but for the Terms/Privacy Policy links that appear directly underneath the previous hook.
forum_list_sidebar
Template: forum_list
Contains the sidebar, basically. Note that this hook currently only works for the forum list's sidebar, not the one that appears on the recent activity page. There are some "sub hooks" in the form of HTML comments that can be hooked into.
<!-- block: sidebar_online_staff --> is before the Staff Online area.
<!-- block: sidebar_online_users --> is between staff online and normal members online.
<!-- block: forum_stats --> is between the online users and statistics.
<!-- end block: forum_stats --> is after the forum stats.
<!-- slot: forum_stats_extra --> is at the end of the statistics list, allowing you to add more stats.
message_user_info_avatar
Template: message_user_info
Parameters
- user: Information about the author of the message.
Contains the avatar holder div, and the avatar of the postbit. <!-- slot: message_user_info_avatar --> is within the avatar holder, after the avatar itself.
message_user_info_text
Template: message_user_info
Parameters
- user: Information about the author of the message.
Contains the username and user title part of the postbit. <!-- slot: message_user_info_text --> is within the <h3 class="userText">, after the user title.
message_user_info_extra
Template: message_user_info
Parameters
- user: Information about the author of the message.
Contains extra information in the postbit (if you have it configured to display), like the post count, number of likes, join date, etc. Could be used to add things like a "Points" field, arcade trophies, etc. to the postbit.
page_container_head
Template: PAGE_CONTAINER
Contains the full contents of the <head> tag. Can be used to add data to the <head> of all pages, or modify what is already there.
page_container_js_body
Template: page_container_js_body
Contains all the various "information passing" code for XenForo, like making options and phrases available to the JavaScript. Would generally be used for passing required JS information to your own addon (at least for what I intend to use it for).