phpBB

Development Wiki

Event List

From phpBB Development Wiki

Revision as of 21:05, 29 March 2014 by Nickvergessen (Talk | contribs)

PHP Events (Hook Locations)

Identifier Placement Arguments Added in Release Explanation
core.acp_bbcodes_display_bbcodes includes/acp/acp_bbcodes.php bbcodes_array, row, u_action 3.1.0-a3 Modify display of custom bbcodes in the form
core.acp_bbcodes_display_form includes/acp/acp_bbcodes.php action, sql_ary, template_data, u_action 3.1.0-a3 Modify custom bbcode template data before we display the form
core.acp_bbcodes_edit_add includes/acp/acp_bbcodes.php action, tpl_ary, bbcode_id, bbcode_tokens 3.1.0-a3 Modify custom bbcode template data before we display the add/edit form
core.acp_bbcodes_modify_create includes/acp/acp_bbcodes.php action, sql_ary, bbcode_id, display_on_posting, bbcode_match, bbcode_tpl, bbcode_helpline, hidden_fields 3.1.0-a3 Modify custom bbcode data before the modify/create action
core.acp_board_config_edit_add includes/acp/acp_board.php display_vars, mode, submit 3.1.0-a4 Event to add and/or modify acp_board configurations
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_posts_after includes/functions_admin.php post_ids, poster_ids, topic_ids, forum_ids, where_type, where_ids, delete_notifications_types 3.1.0-a4 Perform additional actions after post(s) deletion
core.delete_posts_before includes/functions_admin.php where_type, where_ids, auto_sync, posted_sync, post_count_sync, call_delete_topics, delete_notifications_types 3.1.0-a4 Perform additional actions before post(s) deletion
core.delete_posts_in_transaction includes/functions_admin.php post_ids, poster_ids, topic_ids, forum_ids, where_type, where_ids, delete_notifications_types 3.1.0-a4 Perform additional actions during post(s) deletion
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 Event to modify the template data block of a custom bbcode
core.display_custom_bbcodes_modify_sql includes/functions_display.php sql_ary, num_predefined_bbcodes 3.1.0-a3 Event to modify the SQL query before custom bbcode data is queried
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, friend, foe 3.1.0-a1 Modify user data before we display the profile
core.modify_bbcode_init includes/message_parser.php bbcodes, rowset 3.1.0-a3 Event to modify the bbcode data for later parsing
core.modify_format_display_text_after includes/message_parser.php text, uid, allow_bbcode, allow_magic_url, allow_smilies, update_this_message 3.1.0-a3 Event to modify the text after it is parsed
core.modify_mcp_modules_display_option mcp.php module, mode, user_id, forum_id, topic_id, post_id, username, id 3.1.0-b2 This event allows you to set display option for custom MCP modules
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_quickmod_actions includes/mcp/mcp_main.php 3.1.0-a4 This event allows you to handle custom quickmod options
core.modify_quickmod_options mcp.php module, action, is_valid_action 3.1.0-a4 This event allows you to add custom quickmod options
core.modify_submit_post_data includes/functions_posting.php mode, subject, username, topic_type, poll, data, update_message, update_search_index 3.1.0-a4 Modify the data for post submitting
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.module_auth includes/functions_module.php valid_tokens, module_auth, forum_id 3.1-A3 Alter tokens for module authorisation check
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.submit_post_end includes/functions_posting.php url, data 3.1-A3 This event is used for performing actions directly after a post or topic
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_array 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, guest_counter, forum_data 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, forum_data 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 forum_id, topic_id, topic_data, post_list, sort_days, sort_key, sort_dir, start, 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 start, current_row_number, end, row, cp_row, attachments, user_poster_data, post_row 3.1.0-a1 Modify the posts template block
core.viewtopic_post_row_after viewtopic.php start, current_row_number, end, row, cp_row, attachments, user_poster_data, post_row 3.1.0-a3 Event after the post data has been assigned to the template
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

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_contact_after memberlist_view.html memberlist_view.html 3.1.0-b2 Add content after the user contact part of any user profile
memberlist_view_contact_before memberlist_view.html memberlist_view.html 3.1.0-b2 Add content before the user contact part of any user profile
memberlist_view_content_append memberlist_view.html memberlist_view.html 3.1.0-b2 Add custom content to the user profile view after the main content
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_body_before overall_header.html overall_header.html 3.1.0-b2 Add content to the header body
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_content_before overall_header.html overall_header.html 3.1.0-a3 Add content on all pages before the main content, after 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 overall_header.html 3.1.0-a1 Add links after the navigation links in the header
overall_header_navigation_prepend overall_header.html overall_header.html 3.1.0-a1 Add links before the navigation links in the header
posting_editor_buttons_after posting_buttons.html posting_buttons.html 3.1.0-a3 Add content after the BBCode posting buttons
posting_editor_buttons_before posting_buttons.html posting_buttons.html 3.1.0-a3 Add content before the BBCode posting buttons
posting_editor_message_after posting_editor.html posting_body.html 3.1.0-a2 Add field (e.g. textbox) to the posting screen after the message
posting_editor_message_before posting_editor.html posting_body.html 3.1.0-a2 Add field (e.g. textbox) to the posting screen before the message
posting_editor_options_prepend posting_editor.html posting_body.html 3.1.0-a1 Add posting options on the posting screen
posting_editor_subject_after posting_editor.html posting_body.html 3.1.0-a2 Add field (e.g. textbox) to the posting screen after the subject
posting_editor_subject_before posting_editor.html posting_body.html 3.1.0-a2 Add field (e.g. textbox) to the posting screen before the subject
quickreply_editor_panel_after quickreply_editor.html quickreply_editor.html 3.1.0-b2 Add content after the quick reply panel (but inside the form)
quickreply_editor_panel_before quickreply_editor.html quickreply_editor.html 3.1.0-b2 Add content before the quick reply panel (but inside the form)
quickreply_editor_message_after quickreply_editor.html quickreply_editor.html 3.1.0-a4 Add content after the quick reply textbox
quickreply_editor_message_before quickreply_editor.html quickreply_editor.html 3.1.0-a4 Add content before the quick reply textbox
simple_header_body_before simple_header.html simple_header.html 3.1.0-b2 Add content to the header body
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 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
ucp_friend_list_before 3.1.0-a4 Add optional elements before list of friends in UCP
ucp_friend_list_after 3.1.0-a4 Add optional elements after list of friends in UCP
viewtopic_print_head_append viewtopic_print.html 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_body_postrow_post_after viewtopic_body.html viewtopic_body.html 3.1.0-a4 Add data after posts
viewtopic_body_postrow_post_before viewtopic_body.html viewtopic_body.html 3.1.0-a4 Add data before posts
viewtopic_body_postrow_post_notices_after viewtopic_body.html viewtopic_body.html 3.1.0-b2 Add posts specific custom notices at the notices bottom.
viewtopic_body_postrow_post_notices_before viewtopic_body.html viewtopic_body.html 3.1.0-b2 Add posts specific custom notices at the notices top.
viewtopic_body_topic_actions_before viewtopic_body.html viewtopic_body.html 3.1.0-a4 Add data before the topic actions buttons (after the posts sorting options)
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
viewtopic_topic_tools_after viewtopic_topic_tools.html 3.1.0-a3 Add a new topic tool after the rest of the existing ones
viewtopic_topic_tools_before viewtopic_topic_tools.html 3.1.0-a3 Add a new topic tool before the rest of the existing ones

ACP Template Events

Identifier Placement Added in Release Explanation
acp_bbcodes_actions_append acp_bbcodes.html 3.1.0-a3 Add actions to the BBCodes page, after edit/delete buttons
acp_bbcodes_actions_prepend acp_bbcodes.html 3.1.0-a3 Add actions to the BBCodes page, before edit/delete buttons
acp_bbcodes_edit_fieldsets_after acp_bbcodes.html 3.1.0-a3 Add settings to BBCode add/edit form
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_body_before overall_header.html 3.1.0-b2 Add content to the header body
acp_overall_header_head_append overall_header.html 3.1.0-a1 Add assets within the `<head>` tags in the ACP
acp_simple_header_body_before simple_header.html 3.1.0-b2 Add content to the header body
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
acp_users_signature_editor_buttons_after acp_users_signature.html 3.1.0-a3 Add content after BBCode posting buttons in the ACP user signature
acp_users_signature_editor_buttons_before acp_users_signature.html 3.1.0-a3 Add content before BBCode posting buttons in the ACP user signature