phpBB

Development Wiki

Difference between revisions of "Event List"

From phpBB Development Wiki

(Change Version Schema)
(Added Events (Hook Locations))
Line 2: Line 2:
 
{| class="sortable zebra" cellspacing="0" cellpadding="5"
 
{| class="sortable zebra" cellspacing="0" cellpadding="5"
 
! Identifier !! Placement !! Arguments !! Added in Release !! Explanation
 
! Identifier !! Placement !! Arguments !! Added in Release !! Explanation
|- id="core.acp_users_overview"
+
|- id="core.acp_manage_forums_display_form"
| [[#core.acp_users_overview|core.acp_users_overview]] || includes/acp/acp_users.php || $data $check_ary $sql_ary $user_row $quick_tool_ary || 3.1.0-a1 || Modifies the data displayed when editing users
+
| [[#core.acp_manage_forums_display_form|core.acp_manage_forums_display_form]] || includes/acp/acp_forums.php || action, update, forum_id, row, forum_data, parents_list, errors, template_data || 3.1.0-a1 || Modify forum template data before we display the form
|- id="core.acp_modules_modules"
+
|- id="core.acp_manage_forums_initialise_data"
| [[#core.acp_modules_modules|core.acp_modules_modules]] || includes/acp/info/acp_modules.php || $modules || 3.1.0-a1 || Allows you to add/modify new modular control panels
+
| [[#core.acp_manage_forums_initialise_data|core.acp_manage_forums_initialise_data]] || includes/acp/acp_forums.php || action, update, forum_id, row, forum_data, parents_list || 3.1.0-a1 || Initialise data before we display the add/edit form
|- id="core.acp_profile_edit"
+
|- id="core.acp_manage_forums_move_children"
| [[#core.acp_profile_edit|core.acp_profile_edit]] || includes/acp/acp_profile.php || $field_row $visibility_ary $exclude || 3.1.0-a1 || Modifies the profile data for users
+
| [[#core.acp_manage_forums_move_children|core.acp_manage_forums_move_children]] || includes/acp/acp_forums.php || from_id, to_id, errors || 3.1.0-a1 || Event when we move all children of one forum to another
|- id="core.adm_page_header_override"
+
|- id="core.acp_manage_forums_move_content"
| [[#core.adm_page_header_override| core.adm_page_header_override]] || includes/functions_acp.php || $page_title $adm_page_header_override || 3.1.0-a1 || Allows you to add an listener that replaces the phpBB `adm_page_header()` function. If the listener sets the `$event['adm_page_header_override']` property to `true` the function will be skipped further.
+
| [[#core.acp_manage_forums_move_content|core.acp_manage_forums_move_content]] || includes/acp/acp_forums.php || from_id, to_id, sync, errors || 3.1.0-a1 || Event when we move content from one forum to another
|- id="core.adm_page_footer_override"
+
|- id="core.acp_manage_forums_request_data"
| [[#core.adm_page_footer_override| core.adm_page_footer_override]] || includes/functions_acp.php || $copyright_html $adm_page_footer_override || 3.1.0-a1 || Allows you to add an listener that replaces the phpBB `adm_page_footer()` function. If the listener sets the `$event['adm_page_footer_override']` property to `true` the function will be skipped further.
+
| [[#core.acp_manage_forums_request_data|core.acp_manage_forums_request_data]] || includes/acp/acp_forums.php || action, forum_data || 3.1.0-a1 || Request forum data and operate on it (parse texts, etc.)
|- id="core.page_header_override"
+
|- id="core.acp_manage_forums_update_data_after"
| [[#core.page_header_override|core.page_header_override]] || includes/functions.php || $page_title $display_online_list $item_id $item $page_header_override || 3.1.0-a1 || Allows you to add an listener that replaces the phpBB `page_header()` function. If the listener sets the `$event['page_header_override']` property to `true` the page header function will be skipped further.
+
| [[#core.acp_manage_forums_update_data_after|core.acp_manage_forums_update_data_after]] || includes/acp/acp_forums.php || forum_data, forum_data_sql, is_new_forum, errors || 3.1.0-a1 || Event after a forum was updated or created
|- id="core.page_header"
+
|- id="core.acp_manage_forums_update_data_before"
| [[#core.page_header|core.page_header]] || functions.php || $page_title $display_online_list $item_id $item || 3.1.0-a1 || Modifes the page header
+
| [[#core.acp_manage_forums_update_data_before|core.acp_manage_forums_update_data_before]] || includes/acp/acp_forums.php || forum_data, forum_data_sql || 3.1.0-a1 || Remove invalid values from forum_data_sql that should not be updated
|- id="core.page_footer_override"
+
|- id="core.acp_manage_forums_validate_data"
| [[#core.page_footer_override|core.page_footer_override]] || includes/functions.php || $run_cron $page_header_override || 3.1.0-a1 || Allows you to add an listener that replaces the phpBB `page_footer()` function. If the listener sets the `$event['page_footer_override']` property to `true` the page footer function will be skipped further.
+
| [[#core.acp_manage_forums_validate_data|core.acp_manage_forums_validate_data]] || includes/acp/acp_forums.php || forum_data, errors || 3.1.0-a1 || Validate the forum data before we create/update the forum
|- id="core.build_cfg_template"
+
|- id="core.acp_users_display_overview"
| [[#core.build_cfg_template|core.build_cfg_template]] || includes/functions_acp.php || $tpl_type, $key, &$new, $config_key, $vars, $tpl || 3.1.0-a1 || Gives you additional control over the result of the `build_cfg_template()` function.
+
| [[#core.acp_users_display_overview|core.acp_users_display_overview]] || includes/acp/acp_users.php || user_row, quick_tool_ary || 3.1.0-a1 || Add additional quick tool options and overwrite user data
 +
|- id="core.acp_users_overview_modify_data"
 +
| [[#core.acp_users_overview_modify_data|core.acp_users_overview_modify_data]] || includes/acp/acp_users.php || user_row, data, sql_ary || 3.1.0-a1 || Modify user data before we update it
 +
|- id="core.acp_users_overview_run_quicktool"
 +
| [[#core.acp_users_overview_run_quicktool|core.acp_users_overview_run_quicktool]] || includes/acp/acp_users.php || action, user_row || 3.1.0-a1 || Run custom quicktool code
 +
|- id="core.adm_page_footer"
 +
| [[#core.adm_page_footer|core.adm_page_footer]] || includes/functions_acp.php || copyright_html, adm_page_footer_override || 3.1.0-a1 || Execute code and/or overwrite adm_page_footer()
 +
|- id="core.adm_page_header"
 +
| [[#core.adm_page_header|core.adm_page_header]] || includes/functions_acp.php || page_title, adm_page_header_override || 3.1.0-a1 || Execute code and/or overwrite adm_page_header()
 +
|- id="core.append_sid"
 +
| [[#core.append_sid|core.append_sid]] || includes/functions.php || url, params, is_amp, session_id, append_sid_overwrite || 3.1.0-a1 || This event can either supplement or override the append_sid() function
 +
|- id="core.build_config_template"
 +
| [[#core.build_config_template|core.build_config_template]] || includes/functions_acp.php || tpl_type, key, new, name, vars, tpl || 3.1.0-a1 || Overwrite the html code we display for the config value
 
|- id="core.common"
 
|- id="core.common"
| [[#core.common|core.common]] || common.php || N/A || 3.1.0-a1 || Allows you to add code that will be executed on all pages
+
| [[#core.common|core.common]] || common.php || || 3.1.0-a1 || Main event which is triggered on every page
|- id="core.acp_forums_add_forum_data"
+
|- id="core.delete_group_after"
| [[#core.acp_forums_add_forum_data|core.acp_forums_add_forum_data]] || includes/acp/acp_forums.php || $forum_data || 3.1.0-a1 || Modifies the forum data for new forums
+
| [[#core.delete_group_after|core.delete_group_after]] || includes/functions_user.php || group_id, group_name || 3.1.0-a1 || Event after a group is deleted
|- id="core.display_forums_sql_inject"
+
| [[#core.display_forums_sql_inject|core.display_forums_sql_inject]] || includes/functions_display.php || $sql_ary || 3.1.0-a1 || Modifies the query which grabs the data for the forums to display
+
|- id="core.display_forums_row_inject"
+
| [[#core.display_forums_row_inject|core.display_forums_row_inject]] || includes/functions_display.php || $row || 3.1.0-a1 || Modifies the data of a forum row
+
|- id="core.display_forums_row_values_inject"
+
| [[#core.display_forums_row_values_inject|core.display_forums_row_values_inject]] || includes/functions_display.php || $forum_rows, $parent_id, $row || 3.1.0-a1 || Modifies the data of the forum set
+
|- id="core.display_forums_assign_block_vars"
+
| [[#core.display_forums_assign_block_vars|core.display_forums_assign_block_vars]] || includes/functions_display.php || $row || 3.1.0-a1 || Can be used to modify the template data of the forum list
+
|- id="core.garbage_collection"
+
| [[#core.garbage_collection| core.garbage_collection]] || includes/functions.php || N/A || 3.1.0-a1 || Allows you to add code that will be executed when phpBB calls its garbage collection function.
+
|- id="core.group_delete"
+
| [[#core.group_delete|core.group_delete]] || includes/functions_users.php || $group_id, $group_name || 3.1.0-a1 || Can be used to delete the group in other tables
+
|- id="core.group_set_user_default"
+
| [[#core.group_set_user_default|core.group_set_user_default]] || includes/functions_users.php || $group_id, $user_id_ary, $group_attributes, $update_listing, $sql_ary || 3.1.0-a1 || Can be used to perform actions when the user/group colour/avatar/rank is changing
+
|- id="core.group_user_del"
+
| [[#core.group_user_del|core.group_user_del]] || includes/functions_users.php || $group_id, $user_id_ary, $username_ary, $group_name || 3.1.0-a1 || Can be used to perform actions when users are removed from a group
+
 
|- id="core.delete_user_after"
 
|- id="core.delete_user_after"
| [[#core.delete_user_after|core.delete_user_after]] || includes/functions_users.php || $mode, $user_ids, $retain_username || 3.1.0-a1 || Can be used to delete the user(s) or user related data in other tables after users are deleted
+
| [[#core.delete_user_after|core.delete_user_after]] || includes/functions_user.php || mode, user_ids, retain_username || 3.1.0-a1 || Event after a user is deleted
 
|- id="core.delete_user_before"
 
|- id="core.delete_user_before"
| [[#core.delete_user_before|core.delete_user_before]] || includes/functions_users.php || $mode, $user_ids, $retain_username || 3.1.0-a1 || Can be used to delete the user(s) or user related data in other tables before users are deleted
+
| [[#core.delete_user_before|core.delete_user_before]] || includes/functions_user.php || mode, user_ids, retain_username || 3.1.0-a1 || Event before a user is deleted
|- id="core.user_update_name"
+
| [[#core.user_update_name|core.user_update_name]] || includes/functions_users.php || $old_name, $new_name || 3.1.0-a1 || Can be used to update the username in other tables
+
|- id="core.index"
+
| [[#core.index|core.index]] || index.php || $page_title || 3.1.0-a1 || Can be used to perform actions on the index page, aswell to modify the page title
+
|- id="core.memberlist_profile_data"
+
| [[#core.memberlist_profile_data|core.memberlist_profile_data]] || memberlist.php || $data || 3.1.0-a1 || Modifies the array that sends the template variables that are the user's data for the profile page and memberlist
+
|- id="core.memberlist_viewprofile"
+
| [[#core.memberlist_viewprofile|core.memberlist_viewprofile]] || memberlist.php || $member, $user_notes_enabled, $warn_user_enabled || 3.1.0-a1 || Can be used to view additional information on the users profile
+
|- id="core.ucp_modules"
+
| [[#core.ucp_modules|core.ucp_modules]] || ucp.php || $module || 3.1.0-a1 || Can be used to hide modules in the UCP
+
|- id="core.viewforum_topicrow"
+
| [[#core.viewforum_topicrow|core.viewforum_topicrow]] || viewforum.php || $topicrow || 3.1.0-a1 || Modifies the topicrow array
+
|- id="core.viewonline_get_userdata"
+
| [[#core.viewonline_get_userdata|core.viewonline_get_userdata]] || viewonline.php || $sql_ary || 3.1.0-a1 || Modifies the query-array which grabs the data for the userlist
+
|- id="core.viewonline_location"
+
| [[#core.viewonline_location|core.viewonline_location]] || viewonline.php || $on_page, $row, $location, $location_url || 3.1.0-a1 || Can be used to modify the location displayed in the userlist of viewonline
+
|- id="core.viewtopic_postrow"
+
| [[#core.viewtopic_postrow|core.viewtopic_postrow]] || viewtopic.php || $postrow || 3.1.0-a1 || Modifies the topicrow variables
+
|- id="core.display_custom_bbcodes_row"
+
| [[#core.display_custom_bbcodes_row|core.display_custom_bbcodes_row]] || includes/functions_display.php || $custom_tags, $row || 3.1.0-a1 || Modifies the row of a custom bbcode
+
 
|- id="core.display_custom_bbcodes"
 
|- id="core.display_custom_bbcodes"
| [[#core.display_custom_bbcodes|core.display_custom_bbcodes]] || includes/functions_display.php || N/A || 3.1.0-a1 || Can be used to add custom buttons to the bbcode row
+
| [[#core.display_custom_bbcodes|core.display_custom_bbcodes]] || includes/functions_display.php || || 3.1.0-a1 || Display custom bbcodes
|- id="core.generate_smilies_footer"
+
|- id="core.display_custom_bbcodes_modify_row"
| [[#core.generate_smilies_footer|core.generate_smilies_footer]] || includes/functions_posting.php || $mode, $forum_id, $display_link || 3.1.0-a1 || Can be used to overwrite the links and add additional smilies
+
| [[#core.display_custom_bbcodes_modify_row|core.display_custom_bbcodes_modify_row]] || includes/functions_display.php || custom_tags, row || 3.1.0-a1 || Modify the template data block of a bbcode
|- id="core.ucp_pm_viewmesssage"
+
|- id="core.display_forums_modify_forum_rows"
| [[#core.ucp_pm_viewmesssage|core.ucp_pm_viewmesssage]] || includes/ucp/ucp_pm_viewmessage.php || $id, $mode, $folder_id, $msg_id, $folder, $message_row, $cp_row || 3.1.0-a1 || Can add information to the view PM screen
+
| [[#core.display_forums_modify_forum_rows|core.display_forums_modify_forum_rows]] || includes/functions_display.php || forum_rows, subforums, branch_root_id, parent_id, row || 3.1.0-a1 || Event to modify the forum rows data set
|- id="core.ucp_zebra_remove"
+
|- id="core.display_forums_modify_row"
| [[#core.ucp_zebra_remove|core.ucp_zebra_remove]] || includes/ucp/ucp_zebra.php || $data || 3.1.0-a1 || Can be used to perform some action when foes/friends are removed
+
| [[#core.display_forums_modify_row|core.display_forums_modify_row]] || includes/functions_display.php || branch_root_id, row || 3.1.0-a1 || Event to modify the data set of a forum
|- id="core.ucp_zebra_add"
+
|- id="core.display_forums_modify_sql"
| [[#core.ucp_zebra_add|core.ucp_zebra_add]] || includes/ucp/ucp_zebra.php || $mode, $sql_ary || 3.1.0-a1 || Can be used to perform some action when foes/friends are added
+
| [[#core.display_forums_modify_sql|core.display_forums_modify_sql]] || includes/functions_display.php || sql_ary || 3.1.0-a1 || Event to modify the SQL query before the forum data is queried
|- id="core.viewtopic_get_userdata"
+
|- id="core.display_forums_modify_template_vars"
| [[#core.viewtopic_get_userdata|core.viewtopic_get_userdata]] || viewtopic.php || $sql_ary || 3.1.0-a1 || Modifies the query which grabs the user data
+
| [[#core.display_forums_modify_template_vars|core.display_forums_modify_template_vars]] || includes/functions_display.php || forum_row, row || 3.1.0-a1 || Modify the template data block of the forum
|- id="core.viewtopic_user_cache_guest"
+
|- id="core.garbage_collection"
| [[#core.viewtopic_user_cache_guest|core.viewtopic_user_cache_guest]] || viewtopic.php || $user_cache_data, $row, $poster_id || 3.1.0-a1 || Modifies the guest values for later use in the template
+
| [[#core.garbage_collection|core.garbage_collection]] || includes/functions.php ||  || 3.1.0-a1 || Unload some objects, to free some memory, before we finish our task
|- id="core.viewtopic_user_cache"
+
|- id="core.generate_smilies_after"
| [[#core.viewtopic_user_cache|core.viewtopic_user_cache]] || viewtopic.php || $user_cache_data, $row, $poster_id || 3.1.0-a1 || Modifies the user´s values for later use in the template
+
| [[#core.generate_smilies_after|core.generate_smilies_after]] || includes/functions_posting.php || mode, forum_id, display_link || 3.1.0-a1 || This event is called after the smilies are populated
|- id="core.viewtopic_page_header"
+
|- id="core.group_delete_user_before"
| [[#core.viewtopic_page_header|core.viewtopic_page_header]] || viewtopic.php || $page_title, $topic_data, $forum_id, $start || 3.1.0-a1 || Can be used to modify the page title or to load additional files/data
+
| [[#core.group_delete_user_before|core.group_delete_user_before]] || includes/functions_user.php || group_id, group_name, user_id_ary, username_ary || 3.1.0-a1 || Event before users are removed from a group
 +
|- id="core.index_modify_page_title"
 +
| [[#core.index_modify_page_title|core.index_modify_page_title]] || index.php || page_title || 3.1.0-a1 || You can use this event to modify the page title and load data for the index
 +
|- id="core.mcp_view_forum_modify_topicrow"
 +
| [[#core.mcp_view_forum_modify_topicrow|core.mcp_view_forum_modify_topicrow]] || includes/mcp/mcp_forum.php || row, topic_row || 3.1.0-a1 || Modify the topic data before it is assigned to the template in MCP
 +
|- id="core.memberlist_prepare_profile_data"
 +
| [[#core.memberlist_prepare_profile_data|core.memberlist_prepare_profile_data]] || memberlist.php || data, template_data || 3.1.0-a1 || Preparing a user's data before displaying it in profile and memberlist
 +
|- id="core.memberlist_view_profile"
 +
| [[#core.memberlist_view_profile|core.memberlist_view_profile]] || memberlist.php || member, user_notes_enabled, warn_user_enabled, zebra_enabled, friends_enabled, foes_enabled || 3.1.0-a1 || Modify user data before we display the profile
 +
|- id="core.modify_posting_parameters"
 +
| [[#core.modify_posting_parameters|core.modify_posting_parameters]] || posting.php || post_id, topic_id, forum_id, draft_id, lastclick, submit, preview, save, load, delete, cancel, refresh, mode, error || 3.1.0-a1 || This event allows you to alter the above parameters, such as submit and mode
 +
|- id="core.modify_text_for_display_after"
 +
| [[#core.modify_text_for_display_after|core.modify_text_for_display_after]] || includes/functions_content.php || text, uid, bitfield, flags || 3.1.0-a1 || Use this event to modify the text after it is parsed
 +
|- id="core.modify_text_for_display_before"
 +
| [[#core.modify_text_for_display_before|core.modify_text_for_display_before]] || includes/functions_content.php || text, uid, bitfield, flags, censor_text || 3.1.0-a1 || Use this event to modify the text before it is parsed
 +
|- id="core.modify_text_for_edit_after"
 +
| [[#core.modify_text_for_edit_after|core.modify_text_for_edit_after]] || includes/functions_content.php || text, flags || 3.1.0-a1 || Use this event to modify the text after it is decoded for editing
 +
|- id="core.modify_text_for_edit_before"
 +
| [[#core.modify_text_for_edit_before|core.modify_text_for_edit_before]] || includes/functions_content.php || text, uid, flags || 3.1.0-a1 || Use this event to modify the text before it is decoded for editing
 +
|- id="core.modify_text_for_storage_after"
 +
| [[#core.modify_text_for_storage_after|core.modify_text_for_storage_after]] || includes/functions_content.php || text, uid, bitfield, flags || 3.1.0-a1 || Use this event to modify the text after it is prepared for storage
 +
|- id="core.modify_text_for_storage_before"
 +
| [[#core.modify_text_for_storage_before|core.modify_text_for_storage_before]] || includes/functions_content.php || text, uid, bitfield, flags, allow_bbcode, allow_urls, allow_smilies || 3.1.0-a1 || Use this event to modify the text before it is prepared for storage
 +
|- id="core.modify_username_string"
 +
| [[#core.modify_username_string|core.modify_username_string]] || includes/functions_content.php || mode, user_id, username, username_colour, guest_username, custom_profile_url, username_string, _profile_cache || 3.1.0-a1 || Use this event to change the output of get_username_string()
 +
|- id="core.page_footer"
 +
| [[#core.page_footer|core.page_footer]] || includes/functions.php || run_cron, page_footer_override || 3.1.0-a1 || Execute code and/or overwrite page_footer()
 +
|- id="core.page_header"
 +
| [[#core.page_header|core.page_header]] || includes/functions.php || page_title, display_online_list, item_id, item, page_header_override || 3.1.0-a1 || Execute code and/or overwrite page_header()
 +
|- id="core.permissions"
 +
| [[#core.permissions|core.permissions]] || phpbb/permissions.php || types, categories, permissions || 3.1.0-a1 || Allows to specify additional permission categories, types and permissions
 +
|- id="core.posting_modify_template_vars"
 +
| [[#core.posting_modify_template_vars|core.posting_modify_template_vars]] || posting.php ||  || 3.1.0-a1 || This event allows you to modify template variables for the posting screen
 +
|- id="core.search_get_topic_data"
 +
| [[#core.search_get_topic_data|core.search_get_topic_data]] || search.php || sql_select, sql_from, sql_where || 3.1.0-a1 || Event to modify the SQL query before the topic data is retrieved
 +
|- id="core.search_modify_tpl_ary"
 +
| [[#core.search_modify_tpl_ary|core.search_modify_tpl_ary]] || search.php || row, tpl_ary || 3.1.0-a1 || Modify the topic data before it is assigned to the template
 +
|- id="core.ucp_add_zebra"
 +
| [[#core.ucp_add_zebra|core.ucp_add_zebra]] || includes/ucp/ucp_zebra.php || mode, sql_ary || 3.1.0-a1 || Add users to friends/foes
 +
|- id="core.ucp_display_module_before"
 +
| [[#core.ucp_display_module_before|core.ucp_display_module_before]] || ucp.php || module, id, mode || 3.1.0-a1 || Use this event to enable and disable additional UCP modules
 +
|- id="core.ucp_pm_view_messsage"
 +
| [[#core.ucp_pm_view_messsage|core.ucp_pm_view_messsage]] || includes/ucp/ucp_pm_viewmessage.php || id, mode, folder_id, msg_id, folder, message_row, cp_row, msg_data || 3.1.0-a1 || Modify pm and sender data before it is assigned to the template
 +
|- id="core.ucp_prefs_personal_data"
 +
| [[#core.ucp_prefs_personal_data|core.ucp_prefs_personal_data]] || includes/ucp/ucp_prefs.php || submit, data || 3.1.0-a1 || Add UCP edit global settings data before they are assigned to the template or submitted
 +
|- id="core.ucp_prefs_personal_update_data"
 +
| [[#core.ucp_prefs_personal_update_data|core.ucp_prefs_personal_update_data]] || includes/ucp/ucp_prefs.php || data, sql_ary || 3.1.0-a1 || Update UCP edit global settings data on form submit
 +
|- id="core.ucp_prefs_post_data"
 +
| [[#core.ucp_prefs_post_data|core.ucp_prefs_post_data]] || includes/ucp/ucp_prefs.php || submit, data || 3.1.0-a1 || Add UCP edit posting defaults data before they are assigned to the template or submitted
 +
|- id="core.ucp_prefs_post_update_data"
 +
| [[#core.ucp_prefs_post_update_data|core.ucp_prefs_post_update_data]] || includes/ucp/ucp_prefs.php || data, sql_ary || 3.1.0-a1 || Update UCP edit posting defaults data on form submit
 +
|- id="core.ucp_prefs_view_data"
 +
| [[#core.ucp_prefs_view_data|core.ucp_prefs_view_data]] || includes/ucp/ucp_prefs.php || submit, data || 3.1.0-a1 || Add UCP edit display options data before they are assigned to the template or submitted
 +
|- id="core.ucp_prefs_view_update_data"
 +
| [[#core.ucp_prefs_view_update_data|core.ucp_prefs_view_update_data]] || includes/ucp/ucp_prefs.php || data, sql_ary || 3.1.0-a1 || Update UCP edit display options data on form submit
 +
|- id="core.ucp_remove_zebra"
 +
| [[#core.ucp_remove_zebra|core.ucp_remove_zebra]] || includes/ucp/ucp_zebra.php || mode, user_ids || 3.1.0-a1 || Remove users from friends/foes
 +
|- id="core.update_username"
 +
| [[#core.update_username|core.update_username]] || includes/functions_user.php || old_name, new_name || 3.1.0-a1 || Update a username when it is changed
 +
|- id="core.user_add_modify_data"
 +
| [[#core.user_add_modify_data|core.user_add_modify_data]] || includes/functions_user.php || sql_ary || 3.1.0-a1 || Use this event to modify the values to be inserted when a user is added
 +
|- id="core.user_set_default_group"
 +
| [[#core.user_set_default_group|core.user_set_default_group]] || includes/functions_user.php || group_id, user_id_ary, group_attributes, update_listing, sql_ary || 3.1.0-a1 || Event when the default group is set for an array of users
 +
|- id="core.user_setup"
 +
| [[#core.user_setup|core.user_setup]] || phpbb/user.php || user_data, user_lang_name, user_date_format, user_timezone, lang_set, lang_set_ext, style_id || 3.1.0-a1 || Event to load language files and modify user data on every page
 +
|- id="core.validate_config_variable"
 +
| [[#core.validate_config_variable|core.validate_config_variable]] || includes/functions_acp.php || cfg_array, config_name, config_definition, error || 3.1.0-a1 || Validate a config value
 +
|- id="core.viewforum_get_shadowtopic_data"
 +
| [[#core.viewforum_get_shadowtopic_data|core.viewforum_get_shadowtopic_data]] || viewforum.php || sql || 3.1.0-a1 || Event to modify the SQL query before the shadowtopic data is retrieved
 +
|- id="core.viewforum_get_topic_data"
 +
| [[#core.viewforum_get_topic_data|core.viewforum_get_topic_data]] || viewforum.php || sql_array || 3.1.0-a1 || Event to modify the SQL query before the topic data is retrieved
 +
|- id="core.viewforum_modify_topicrow"
 +
| [[#core.viewforum_modify_topicrow|core.viewforum_modify_topicrow]] || viewforum.php || row, topic_row || 3.1.0-a1 || Modify the topic data before it is assigned to the template
 +
|- id="core.viewonline_modify_sql"
 +
| [[#core.viewonline_modify_sql|core.viewonline_modify_sql]] || viewonline.php || sql_ary, show_guests || 3.1.0-a1 || Modify the SQL query for getting the user data to display viewonline list
 +
|- id="core.viewonline_overwrite_location"
 +
| [[#core.viewonline_overwrite_location|core.viewonline_overwrite_location]] || viewonline.php || on_page, row, location, location_url || 3.1.0-a1 || Overwrite the location's name and URL, which are displayed in the list
 +
|- id="core.viewtopic_cache_guest_data"
 +
| [[#core.viewtopic_cache_guest_data|core.viewtopic_cache_guest_data]] || viewtopic.php || user_cache_data, poster_id, row || 3.1.0-a1 || Modify the guest user's data displayed with the posts
 +
|- id="core.viewtopic_cache_user_data"
 +
| [[#core.viewtopic_cache_user_data|core.viewtopic_cache_user_data]] || viewtopic.php || user_cache_data, poster_id, row || 3.1.0-a1 || Modify the users' data displayed with their posts
 +
|- id="core.viewtopic_get_post_data"
 +
| [[#core.viewtopic_get_post_data|core.viewtopic_get_post_data]] || viewtopic.php || sql_ary || 3.1.0-a1 || Event to modify the SQL query before the post and poster data is retrieved
 +
|- id="core.viewtopic_modify_page_title"
 +
| [[#core.viewtopic_modify_page_title|core.viewtopic_modify_page_title]] || viewtopic.php || page_title, topic_data, forum_id, start || 3.1.0-a1 || You can use this event to modify the page title of the viewtopic page
 +
|- id="core.viewtopic_modify_post_row"
 +
| [[#core.viewtopic_modify_post_row|core.viewtopic_modify_post_row]] || viewtopic.php || row, cp_row, user_poster_data, post_row || 3.1.0-a1 || Modify the posts template block
 +
|- id="core.viewtopic_post_rowset_data"
 +
| [[#core.viewtopic_post_rowset_data|core.viewtopic_post_rowset_data]] || viewtopic.php || rowset_data, row || 3.1.0-a1 || Modify the post rowset containing data to be displayed with posts
 
|}
 
|}
  

Revision as of 14:29, 16 October 2013

Added Events (Hook Locations)

Identifier Placement Arguments Added in Release Explanation
core.acp_manage_forums_display_form includes/acp/acp_forums.php action, update, forum_id, row, forum_data, parents_list, errors, template_data 3.1.0-a1 Modify forum template data before we display the form
core.acp_manage_forums_initialise_data includes/acp/acp_forums.php action, update, forum_id, row, forum_data, parents_list 3.1.0-a1 Initialise data before we display the add/edit form
core.acp_manage_forums_move_children includes/acp/acp_forums.php from_id, to_id, errors 3.1.0-a1 Event when we move all children of one forum to another
core.acp_manage_forums_move_content includes/acp/acp_forums.php from_id, to_id, sync, errors 3.1.0-a1 Event when we move content from one forum to another
core.acp_manage_forums_request_data includes/acp/acp_forums.php action, forum_data 3.1.0-a1 Request forum data and operate on it (parse texts, etc.)
core.acp_manage_forums_update_data_after includes/acp/acp_forums.php forum_data, forum_data_sql, is_new_forum, errors 3.1.0-a1 Event after a forum was updated or created
core.acp_manage_forums_update_data_before includes/acp/acp_forums.php forum_data, forum_data_sql 3.1.0-a1 Remove invalid values from forum_data_sql that should not be updated
core.acp_manage_forums_validate_data includes/acp/acp_forums.php forum_data, errors 3.1.0-a1 Validate the forum data before we create/update the forum
core.acp_users_display_overview includes/acp/acp_users.php user_row, quick_tool_ary 3.1.0-a1 Add additional quick tool options and overwrite user data
core.acp_users_overview_modify_data includes/acp/acp_users.php user_row, data, sql_ary 3.1.0-a1 Modify user data before we update it
core.acp_users_overview_run_quicktool includes/acp/acp_users.php action, user_row 3.1.0-a1 Run custom quicktool code
core.adm_page_header includes/functions_acp.php page_title, adm_page_header_override 3.1.0-a1 Execute code and/or overwrite adm_page_header()
core.append_sid includes/functions.php url, params, is_amp, session_id, append_sid_overwrite 3.1.0-a1 This event can either supplement or override the append_sid() function
core.build_config_template includes/functions_acp.php tpl_type, key, new, name, vars, tpl 3.1.0-a1 Overwrite the html code we display for the config value
core.common common.php 3.1.0-a1 Main event which is triggered on every page
core.delete_group_after includes/functions_user.php group_id, group_name 3.1.0-a1 Event after a group is deleted
core.delete_user_after includes/functions_user.php mode, user_ids, retain_username 3.1.0-a1 Event after a user is deleted
core.delete_user_before includes/functions_user.php mode, user_ids, retain_username 3.1.0-a1 Event before a user is deleted
core.display_custom_bbcodes includes/functions_display.php 3.1.0-a1 Display custom bbcodes
core.display_custom_bbcodes_modify_row includes/functions_display.php custom_tags, row 3.1.0-a1 Modify the template data block of a bbcode
core.display_forums_modify_forum_rows includes/functions_display.php forum_rows, subforums, branch_root_id, parent_id, row 3.1.0-a1 Event to modify the forum rows data set
core.display_forums_modify_row includes/functions_display.php branch_root_id, row 3.1.0-a1 Event to modify the data set of a forum
core.display_forums_modify_sql includes/functions_display.php sql_ary 3.1.0-a1 Event to modify the SQL query before the forum data is queried
core.display_forums_modify_template_vars includes/functions_display.php forum_row, row 3.1.0-a1 Modify the template data block of the forum
core.garbage_collection includes/functions.php 3.1.0-a1 Unload some objects, to free some memory, before we finish our task
core.generate_smilies_after includes/functions_posting.php mode, forum_id, display_link 3.1.0-a1 This event is called after the smilies are populated
core.group_delete_user_before includes/functions_user.php group_id, group_name, user_id_ary, username_ary 3.1.0-a1 Event before users are removed from a group
core.index_modify_page_title index.php page_title 3.1.0-a1 You can use this event to modify the page title and load data for the index
core.mcp_view_forum_modify_topicrow includes/mcp/mcp_forum.php row, topic_row 3.1.0-a1 Modify the topic data before it is assigned to the template in MCP
core.memberlist_prepare_profile_data memberlist.php data, template_data 3.1.0-a1 Preparing a user's data before displaying it in profile and memberlist
core.memberlist_view_profile memberlist.php member, user_notes_enabled, warn_user_enabled, zebra_enabled, friends_enabled, foes_enabled 3.1.0-a1 Modify user data before we display the profile
core.modify_posting_parameters posting.php post_id, topic_id, forum_id, draft_id, lastclick, submit, preview, save, load, delete, cancel, refresh, mode, error 3.1.0-a1 This event allows you to alter the above parameters, such as submit and mode
core.modify_text_for_display_after includes/functions_content.php text, uid, bitfield, flags 3.1.0-a1 Use this event to modify the text after it is parsed
core.modify_text_for_display_before includes/functions_content.php text, uid, bitfield, flags, censor_text 3.1.0-a1 Use this event to modify the text before it is parsed
core.modify_text_for_edit_after includes/functions_content.php text, flags 3.1.0-a1 Use this event to modify the text after it is decoded for editing
core.modify_text_for_edit_before includes/functions_content.php text, uid, flags 3.1.0-a1 Use this event to modify the text before it is decoded for editing
core.modify_text_for_storage_after includes/functions_content.php text, uid, bitfield, flags 3.1.0-a1 Use this event to modify the text after it is prepared for storage
core.modify_text_for_storage_before includes/functions_content.php text, uid, bitfield, flags, allow_bbcode, allow_urls, allow_smilies 3.1.0-a1 Use this event to modify the text before it is prepared for storage
core.modify_username_string includes/functions_content.php mode, user_id, username, username_colour, guest_username, custom_profile_url, username_string, _profile_cache 3.1.0-a1 Use this event to change the output of get_username_string()
core.page_header includes/functions.php page_title, display_online_list, item_id, item, page_header_override 3.1.0-a1 Execute code and/or overwrite page_header()
core.permissions phpbb/permissions.php types, categories, permissions 3.1.0-a1 Allows to specify additional permission categories, types and permissions
core.posting_modify_template_vars posting.php 3.1.0-a1 This event allows you to modify template variables for the posting screen
core.search_get_topic_data search.php sql_select, sql_from, sql_where 3.1.0-a1 Event to modify the SQL query before the topic data is retrieved
core.search_modify_tpl_ary search.php row, tpl_ary 3.1.0-a1 Modify the topic data before it is assigned to the template
core.ucp_add_zebra includes/ucp/ucp_zebra.php mode, sql_ary 3.1.0-a1 Add users to friends/foes
core.ucp_display_module_before ucp.php module, id, mode 3.1.0-a1 Use this event to enable and disable additional UCP modules
core.ucp_pm_view_messsage includes/ucp/ucp_pm_viewmessage.php id, mode, folder_id, msg_id, folder, message_row, cp_row, msg_data 3.1.0-a1 Modify pm and sender data before it is assigned to the template
core.ucp_prefs_personal_data includes/ucp/ucp_prefs.php submit, data 3.1.0-a1 Add UCP edit global settings data before they are assigned to the template or submitted
core.ucp_prefs_personal_update_data includes/ucp/ucp_prefs.php data, sql_ary 3.1.0-a1 Update UCP edit global settings data on form submit
core.ucp_prefs_post_data includes/ucp/ucp_prefs.php submit, data 3.1.0-a1 Add UCP edit posting defaults data before they are assigned to the template or submitted
core.ucp_prefs_post_update_data includes/ucp/ucp_prefs.php data, sql_ary 3.1.0-a1 Update UCP edit posting defaults data on form submit
core.ucp_prefs_view_data includes/ucp/ucp_prefs.php submit, data 3.1.0-a1 Add UCP edit display options data before they are assigned to the template or submitted
core.ucp_prefs_view_update_data includes/ucp/ucp_prefs.php data, sql_ary 3.1.0-a1 Update UCP edit display options data on form submit
core.ucp_remove_zebra includes/ucp/ucp_zebra.php mode, user_ids 3.1.0-a1 Remove users from friends/foes
core.update_username includes/functions_user.php old_name, new_name 3.1.0-a1 Update a username when it is changed
core.user_add_modify_data includes/functions_user.php sql_ary 3.1.0-a1 Use this event to modify the values to be inserted when a user is added
core.user_set_default_group includes/functions_user.php group_id, user_id_ary, group_attributes, update_listing, sql_ary 3.1.0-a1 Event when the default group is set for an array of users
core.user_setup phpbb/user.php user_data, user_lang_name, user_date_format, user_timezone, lang_set, lang_set_ext, style_id 3.1.0-a1 Event to load language files and modify user data on every page
core.validate_config_variable includes/functions_acp.php cfg_array, config_name, config_definition, error 3.1.0-a1 Validate a config value
core.viewforum_get_shadowtopic_data viewforum.php sql 3.1.0-a1 Event to modify the SQL query before the shadowtopic data is retrieved
core.viewforum_get_topic_data viewforum.php sql_array 3.1.0-a1 Event to modify the SQL query before the topic data is retrieved
core.viewforum_modify_topicrow viewforum.php row, topic_row 3.1.0-a1 Modify the topic data before it is assigned to the template
core.viewonline_modify_sql viewonline.php sql_ary, show_guests 3.1.0-a1 Modify the SQL query for getting the user data to display viewonline list
core.viewonline_overwrite_location viewonline.php on_page, row, location, location_url 3.1.0-a1 Overwrite the location's name and URL, which are displayed in the list
core.viewtopic_cache_guest_data viewtopic.php user_cache_data, poster_id, row 3.1.0-a1 Modify the guest user's data displayed with the posts
core.viewtopic_cache_user_data viewtopic.php user_cache_data, poster_id, row 3.1.0-a1 Modify the users' data displayed with their posts
core.viewtopic_get_post_data viewtopic.php sql_ary 3.1.0-a1 Event to modify the SQL query before the post and poster data is retrieved
core.viewtopic_modify_page_title viewtopic.php page_title, topic_data, forum_id, start 3.1.0-a1 You can use this event to modify the page title of the viewtopic page
core.viewtopic_modify_post_row viewtopic.php row, cp_row, user_poster_data, post_row 3.1.0-a1 Modify the posts template block
core.viewtopic_post_rowset_data viewtopic.php rowset_data, row 3.1.0-a1 Modify the post rowset containing data to be displayed with posts

Added Template Events

Identifier Prosilver Placement (If applicable) Subsilver Placement (If applicable) Added in Release Explanation
index_body_stat_blocks_before index_body.html index_body.html 3.1.0-a1 Add new statistic blocks above the Who Is Online and Board Statistics blocks
memberlist_body_username_append memberlist_body.html memberlist_body.html 3.1.0-a1 Add information after every username in the memberlist. Works in all display modes (leader, group and normal memberlist).
memberlist_body_username_prepend memberlist_body.html memberlist_body.html 3.1.0-a1 Add information before every username in the memberlist. Works in all display modes (leader, group and normal memberlist).
memberlist_view_user_statistics_after memberlist_view.html memberlist_view.html 3.1.0-a1 Add entries after the user statistics part of any user profile
memberlist_view_user_statistics_before memberlist_view.html memberlist_view.html 3.1.0-a1 Add entries before the user statistics part of any user profile
overall_header_breadcrumb_append overall_header.html breadcrumbs.html 3.1.0-a1 Add links to the list of breadcrumbs in the header
overall_header_head_append overall_header.html overall_header.html 3.1.0-a1 Add asset calls directly before the `</head>` tag
overall_header_navigation_append overall_header.html 3.1.0-a1 Add links after the navigation links in the header
overall_header_navigation_prepend overall_header.html 3.1.0-a1 Add links before the navigation links in the header
posting_editor_options_prepend posting_editor.html, posting_body.html 3.1.0-a1 Add posting options on the posting screen
topiclist_row_prepend search_results.html, viewforum_body.html search_results.html, viewforum_body.html 3.1.0-a1 Add content into topic rows (inside the elements containing topic titles)
topiclist_row_append search_results.html, viewforum_body.html search_results.html, viewforum_body.html 3.1.0-a1 Add content into topic rows (inside the elements containing topic titles)
ucp_pm_viewmessage_custom_fields_after ucp_pm_viewmessage.html 3.1.0-a1 Add data after the custom fields on the user profile when viewing a private message
ucp_pm_viewmessage_custom_fields_before ucp_pm_viewmessage.html 3.1.0-a1 Add data before the custom fields on the user profile when viewing a private message
ucp_pm_viewmessage_print_head_append ucp_pm_viewmessage_print.html 3.1.0-a1 Add asset calls directly before the `</head>` tag of the Print PM screen
ucp_prefs_personal_prepend ucp_prefs_personal.html ucp_prefs_personal.html 3.1.0-a1 Add user options to the top of the Edit Global Settings block
ucp_prefs_personal_append ucp_prefs_personal.html ucp_prefs_personal.html 3.1.0-a1 Add user options to the bottom of the Edit Global Settings block
ucp_prefs_post_prepend ucp_prefs_post.html ucp_prefs_post.html 3.1.0-a1 Add user options to the top of the Edit Posting Defaults block
ucp_prefs_post_append ucp_prefs_post.html ucp_prefs_post.html 3.1.0-a1 Add user options to the bottom of the Edit Posting Defaults block
ucp_prefs_view_radio_buttons_prepend ucp_prefs_view.html ucp_prefs_view.html 3.1.0-a1 Add options to the top of the radio buttons block of the Edit Display Options screen
ucp_prefs_view_radio_buttons_append ucp_prefs_view.html ucp_prefs_view.html 3.1.0-a1 Add options to the bottom of the radio buttons block of the Edit Display Options screen
ucp_prefs_view_select_menu_prepend ucp_prefs_view.html ucp_prefs_view.html 3.1.0-a1 Add options to the top of the drop-down lists block of the Edit Display Options screen
ucp_prefs_view_select_menu_append ucp_prefs_view.html ucp_prefs_view.html 3.1.0-a1 Add options to the bottom of the drop-down lists block of the Edit Display Options screen
viewtopic_print_head_append viewtopic_print.html 3.1.0-a1 Add asset calls directly before the `</head>` tag of the Print Topic screen
viewtopic_body_post_buttons_after viewtopic_body.html viewtopic_body.html 3.1.0-a1 Add post button to posts (next to edit, quote etc), at the end of the list.
viewtopic_body_post_buttons_before viewtopic_body.html viewtopic_body.html 3.1.0-a1 Add post button to posts (next to edit, quote etc), at the start of the list.
viewtopic_body_postrow_custom_fields_after viewtopic_body.html viewtopic_body.html 3.1.0-a1 Add data after the custom fields on the user profile when viewing a post
viewtopic_body_postrow_custom_fields_before viewtopic_body.html viewtopic_body.html 3.1.0-a1 Add data before the custom fields on the user profile when viewing a post
viewtopic_topic_title_prepend viewtopic_body.html viewtopic_body.html 3.1.0-a1 Add content directly before the topic title link on the View topic screen

Added ACP Template Events

Identifier Placement Added in Release Explanation
acp_forums_normal_settings_append acp_forums.html 3.1.0-a1 Add settings to forums
acp_main_actions_append acp_main.html 3.1.0-a1 Add actions to the ACP main page below the cache purge action
acp_main_notice_after acp_main.html 3.1.0-a1 Add notices or other blocks in the ACP below other configuration notices
acp_overall_header_head_append overall_header.html 3.1.0-a1 Add assets within the `<head>` tags in the ACP
acp_simple_header_head_append overall_header.html 3.1.0-a1 Add assets within the `<head>` tags in the simple header of the ACP
acp_users_overview_options_append acp_users.html 3.1.0-a1 Add options and settings on user overview page