phpBB

Development Wiki

Event List

From phpBB Development Wiki

Revision as of 16:05, 15 October 2013 by Nickvergessen (Talk | contribs)

Added Events (Hook Locations)

Identifier Placement Arguments Added in Release Explanation
core.acp_users_overview includes/acp/acp_users.php $data $check_ary $sql_ary $user_row $quick_tool_ary 3.1 Alpha Modifies the data displayed when editing users
core.acp_modules_modules includes/acp/info/acp_modules.php $modules 3.1 Alpha Allows you to add/modify new modular control panels
core.acp_profile_edit includes/acp/acp_profile.php $field_row $visibility_ary $exclude 3.1 Alpha Modifies the profile data for users
core.adm_page_header_override includes/functions_acp.php $page_title $adm_page_header_override 3.1 Alpha 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.page_header_override includes/functions.php $page_title $display_online_list $item_id $item $page_header_override 3.1 Alpha 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.page_header functions.php $page_title $display_online_list $item_id $item 3.1 Alpha Modifes the page header
core.build_cfg_template includes/functions_acp.php $tpl_type, $key, &$new, $config_key, $vars, $tpl 3.1 Alpha Gives you additional control over the result of the `build_cfg_template()` function.
core.common common.php N/A 3.1 Alpha Allows you to add code that will be executed on all pages
core.acp_forums_add_forum_data includes/acp/acp_forums.php $forum_data 3.1 Alpha Modifies the forum data for new forums
core.display_forums_sql_inject includes/functions_display.php $sql_ary 3.1 Alpha Modifies the query which grabs the data for the forums to display
core.display_forums_row_inject includes/functions_display.php $row 3.1 Alpha Modifies the data of a forum row
core.display_forums_row_values_inject includes/functions_display.php $forum_rows, $parent_id, $row 3.1 Alpha Modifies the data of the forum set
core.display_forums_assign_block_vars includes/functions_display.php $row 3.1 Alpha Can be used to modify the template data of the forum list
core.garbage_collection includes/functions.php N/A 3.1 Alpha Allows you to add code that will be executed when phpBB calls its garbage collection function.
core.group_delete includes/functions_users.php $group_id, $group_name 3.1 Alpha Can be used to delete the group in other tables
core.group_set_user_default includes/functions_users.php $group_id, $user_id_ary, $group_attributes, $update_listing, $sql_ary 3.1 Alpha Can be used to perform actions when the user/group colour/avatar/rank is changing
core.group_user_del includes/functions_users.php $group_id, $user_id_ary, $username_ary, $group_name 3.1 Alpha Can be used to perform actions when users are removed from a group
core.delete_user_after includes/functions_users.php $mode, $user_ids, $retain_username 3.1 Alpha Can be used to delete the user(s) or user related data in other tables after users are deleted
core.delete_user_before includes/functions_users.php $mode, $user_ids, $retain_username 3.1 Alpha Can be used to delete the user(s) or user related data in other tables before users are deleted
core.user_update_name includes/functions_users.php $old_name, $new_name 3.1 Alpha Can be used to update the username in other tables
core.index index.php $page_title 3.1 Alpha Can be used to perform actions on the index page, aswell to modify the page title
core.memberlist_profile_data memberlist.php $data 3.1 Alpha Modifies the array that sends the template variables that are the user's data for the profile page and memberlist
core.memberlist_viewprofile memberlist.php $member, $user_notes_enabled, $warn_user_enabled 3.1 Alpha Can be used to view additional information on the users profile
core.ucp_modules ucp.php $module 3.1 Alpha Can be used to hide modules in the UCP
core.viewforum_topicrow viewforum.php $topicrow 3.1 Alpha Modifies the topicrow array
core.viewonline_get_userdata viewonline.php $sql_ary 3.1 Alpha Modifies the query-array which grabs the data for the userlist
core.viewonline_location viewonline.php $on_page, $row, $location, $location_url 3.1 Alpha Can be used to modify the location displayed in the userlist of viewonline
core.viewtopic_postrow viewtopic.php $postrow 3.1 Alpha Modifies the topicrow variables
core.display_custom_bbcodes_row includes/functions_display.php $custom_tags, $row 3.1 Alpha Modifies the row of a custom bbcode
core.display_custom_bbcodes includes/functions_display.php N/A 3.1 Alpha Can be used to add custom buttons to the bbcode row
core.ucp_pm_viewmesssage includes/ucp/ucp_pm_viewmessage.php $id, $mode, $folder_id, $msg_id, $folder, $message_row, $cp_row 3.1 Alpha Can add information to the view PM screen
core.ucp_zebra_remove includes/ucp/ucp_zebra.php $data 3.1 Alpha Can be used to perform some action when foes/friends are removed
core.ucp_zebra_add includes/ucp/ucp_zebra.php $mode, $sql_ary 3.1 Alpha Can be used to perform some action when foes/friends are added
core.viewtopic_get_userdata viewtopic.php $sql_ary 3.1 Alpha Modifies the query which grabs the user data
core.viewtopic_user_cache_guest viewtopic.php $user_cache_data, $row, $poster_id 3.1 Alpha Modifies the guest values for later use in the template
core.viewtopic_user_cache viewtopic.php $user_cache_data, $row, $poster_id 3.1 Alpha Modifies the user´s values for later use in the template
core.viewtopic_page_header viewtopic.php $page_title, $topic_data, $forum_id, $start 3.1 Alpha Can be used to modify the page title or to load additional files/data

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