Piwigo Core Triggers

Name Type Variables Usage in the core Commentary
allow_increment_element_hit_count trigger_event bool $content_not_set picture.php
begin_delete_elements trigger_action array $ids admin\include\functions.inc.php (delete_elements)
blockmanager_apply trigger_action object $menublock include\block.class.php (BlockManager::apply) use this trigger to modify existing menu blocks
blockmanager_prepare_display trigger_action object $this include\block.class.php (BlockManager::prepare_display)
blockmanager_register_blocks trigger_action object $menu include\block.class.php (BlockManager::load_registered_blocks) use this trigger to add menu block
clean_iptc_value trigger_event string $value include\functions_metadata.inc.php (clean_iptc_value)
combined_css trigger_event string $href, int $file_ver0, int $file_ver1 include\template.class.php (Template::flush)
combined_css_postfilter trigger_event string $css include\template.class.php (Template::process_css)
combined_script trigger_event string $ret, string $script include\template.class.php (Template::make_script_src)
delete_categories trigger_action array $ids admin\include\functions.inc.php (delete_categories)
delete_elements trigger_action array $ids admin\include\functions.inc.php (delete_elements)
delete_user trigger_action int $user_id admin\include\functions.inc.php (delete_user)
element_set_global_action trigger_action string $action, array $collection admin\batch_manager_global.php
format_exif_data trigger_event array $exif, string $filename, array $map include\functions_metadata.inc.php (get_exif_data)
functions_history_included trigger_action admin\include\functions_history.inc.php
functions_mail_included trigger_action include\functions_mail.inc.php
get_admin_advanced_features_links trigger_event array $advanced_features admin\maintenance.php
get_admin_plugin_menu_links trigger_event array admin.php use this trigger to add links into admin plugins menu
get_admins_site_links trigger_event array $plugin_links, int $site_id, bool $is_remote admin\site_manager.php
get_batch_manager_prefilters trigger_event array $prefilters admin\batch_manager_global.php use this trigger to add prefilters into batch manager global
get_categories_menu_sql_where trigger_event string $where, bool $user_expand, bool $filter_enabled include\functions_category.inc.php (get_categories_menu)
get_category_preferred_image_orders trigger_event array include\functions_category.inc.php (get_category_preferred_image_orders)
get_download_url trigger_event string $url, array $element_info include\functions_picture.inc.php (get_download_url)
get_element_metadata_available trigger_event bool , string $element_path picture.php
get_element_url trigger_event string $url, array $element_info include\functions_picture.inc.php (get_element_url)
get_high_location trigger_event string $location, array $element_info include\functions_picture.inc.php (get_high_location)
get_high_url trigger_event string $url, array $element_info include\functions_picture.inc.php (get_high_url)
get_history trigger_event array , array $page_search, array $types admin\history.php
get_image_location trigger_event string $path, array $element_info include\functions_picture.inc.php (get_image_location)
get_popup_help_content trigger_event string $help_content, string $page admin\popuphelp.php
popuphelp.php
get_pwg_themes trigger_event array $themes include\functions.inc.php (get_pwg_themes)
get_thumbnail_title trigger_event string $title, array $info include\functions.inc.php (get_thumbnail_title)
get_comments_derivative_params trigger_event ImageStdParams comments.php New in 2.4
get_index_album_derivative_params trigger_event ImageStdParams includecategory_cats.php
include\category_default.inc.php
New in 2.4
get_src_image_url trigger_event string $url, SrcImage $this include\derivative.inc.php (SrcImage::__construct) New in 2.4
get_derivative_url trigger_event string $url, ImageStdParams , SrcImage $this, string $rel_url include\derivative.inc.php (SrcImage::url, SrcImage::get_url) New in 2.4
get_tag_alt_names trigger_event array , array $raw_name admin\tags.php
admin\include\functions.php (get_taglist)
New in 2.4
init trigger_action include\common.inc.php this action is called just after the common initialization, $conf, $user and $page (partial) variables are availables
invalidate_user_cache trigger_action bool $full admin\include\functions.inc.php (invalidate_user_cache)
list_check_integrity trigger_action object $this admin\include\check_integrity.class.php (check_integrity::check)
load_image_library trigger_action object $this admin\include\image.class.php (pwg_image::__construct)
load_profile_in_template trigger_action array $userdata profile.php (load_profile_in_template)
loading_lang trigger_action include\common.inc.php
include\functions.inc.php (redirect_html)
include\functions_mail.inc.php (switch_lang_to)
nbm.php
loc_after_page_header trigger_action include\page_header.php
loc_begin_about trigger_action about.php
loc_begin_admin trigger_action admin.php
loc_begin_admin_page trigger_action admin.php
loc_begin_cat_list trigger_action admin\cat_list.php
loc_begin_cat_modify trigger_action admin\cat_modify.php
loc_begin_element_set_global trigger_action admin\batch_manager_global.php
loc_begin_element_set_unit trigger_action admin\batch_manager_unit.php
loc_begin_index trigger_action index.php
loc_begin_index_category_thumbnails trigger_action array $categories include\category_cats.inc.php
loc_begin_index_thumbnails trigger_action array $pictures include\category_default.inc.php
loc_begin_page_header trigger_action include\page_header.php
loc_begin_page_tail trigger_action include\page_tail.php
loc_begin_picture trigger_action picture.php
loc_begin_profile trigger_action profile.php
loc_begin_password trigger_action password.php New in 2.5
loc_begin_register trigger_action register.php New in 2.5
loc_begin_search trigger_action search.php New in 2.5
loc_begin_tags trigger_action tags.php New in 2.5
loc_begin_comments trigger_action comments.php New in 2.5
loc_begin_identification trigger_action identification.php New in 2.5
loc_begin_notification trigger_action notification.php New in 2.5
loc_end_password trigger_action password.php New in 2.5
loc_end_register trigger_action register.php New in 2.5
loc_end_search trigger_action search.php New in 2.5
loc_end_tags trigger_action tags.php New in 2.5
loc_end_comments trigger_action comments.php New in 2.5
loc_end_identification trigger_action identification.php New in 2.5
loc_end_notification trigger_action notification.php New in 2.5
loc_end_admin trigger_action admin.php
loc_end_cat_list trigger_action admin\cat_list.php
loc_end_cat_modify trigger_action admin\cat_modify.php
loc_end_element_set_global trigger_action admin\batch_manager_global.php
loc_end_element_set_unit trigger_action admin\batch_manager_unit.php
loc_end_index trigger_action index.php
loc_end_index_category_thumbnails trigger_event array $tpl_thumbnails_var include\category_cats.inc.php
loc_end_index_thumbnails trigger_event array $tpl_thumbnails_var, array $pictures include\category_default.inc.php
loc_end_page_header trigger_action include\page_header.php
loc_end_page_tail trigger_action include\page_tail.php
loc_end_picture trigger_action picture.php
loc_end_profile trigger_action profile.php
loc_end_section_init trigger_action include\section_init.inc.php this action is called after section initilization, $page variable is fully defined
loc_visible_user_list trigger_event array $visible_user_list admin\user_list.php
login_failure trigger_action string $username include\functions_user.inc.php (try_log_user)
login_success trigger_action string $username include\functions_user.inc.php (auto_login, try_log_user)
mail_group_assign_vars trigger_event array $assign_vars include\functions_mail.inc.php (pwg_mail_group)
nbm_event_handler_added trigger_action admin\notification_by_mail.php
nbm_render_global_customize_mail_content trigger_event string $customize_mail_content admin\notification_by_mail.php (do_action_send_mail_notification)
nbm_render_user_customize_mail_content trigger_event string $customize_mail_content, string $nbm_user admin\notification_by_mail.php (do_action_send_mail_notification)
perform_batch_manager_prefilters trigger_event array $filter_sets, string $session_prefilter admin\batch_manager.php
picture_pictures_data trigger_event array $picture picture.php
plugins_loaded trigger_action include\functions_plugins.inc.php (load_plugins)
pwg_log_allowed trigger_event bool $do_log, int $image_id, string $image_type include\functions.inc.php (pwg_log)
register_user trigger_action array $user include\functions_user.inc.php (register_user)
register_user_check trigger_event array $errors, array $user include\functions_user.inc.php (register_user)
render_category_description trigger_event string $category_description, string $action include\category_cats.inc.php
include\section_init.inc.php
include\ws_functions.inc.php (ws_categories_getList, ws_categories_getAdminList)
render_category_literal_description trigger_event string $category_description include\category_cats.inc.php
render_category_name trigger_event string $category_name, string $location admin\cat_list.php
include\ws_functions.inc.php (ws_categories_getList, ws_categories_getAdminList, ws_categories_move)
render_comment_author trigger_event string $comment_author admin\comments.php
comments.php
include\picture_comment.inc.php
render_comment_content trigger_event string $comment_content admin\comments.php
comments.php
include\picture_comment.inc.php
render_element_content trigger_event string $content, array $current_picture picture.php
render_element_name trigger_event string $element_name include\functions_html.inc.php (render_element_name)
render_element_description trigger_event string $element_secription picture.php
render_lost_password_mail_content trigger_event string $message password.php (process_password_request)
render_page_banner trigger_event string $gallery_title include\page_header.php
render_tag_name trigger_event string $tag_name admin\include\functions.php (get_taglist)
admin\tags.php
include\functions_tag.inc.php (get_available_tags, get_all_tags, get_common_tags)
index.php
render_tag_url trigger_event string $tag_name include\functions.php (tag_id_from_tag_name, create_tag)
admin\tags.php
save_profile_from_post trigger_action int $user_id profile.php (save_profile_from_post)
send_mail trigger_event bool $result, string $mail_to, string $mail_subject, string $mail_content, array $mail_headers include\functions_mail.inc.php (pwg_mail)
send_mail_content trigger_event string $content include\functions_mail.inc.php (pwg_mail)
send_mail_headers trigger_event array $headers include\functions_mail.inc.php (pwg_mail)
send_mail_subject trigger_event string $cvt_subject include\functions_mail.inc.php (pwg_mail)
send_mail_to trigger_event string $to include\functions_mail.inc.php (pwg_mail)
sendResponse trigger_action string $encodedResponse include\ws_core.inc.php (PwgServer::sendResponse)
set_status_header trigger_action int $code, string $text include\functions_html.inc.php (set_status_header)
tabsheet_before_select trigger_event array $sheets, string $tabsheet_id include\tabsheet.class.php (tabsheet::select) New in 2.4, use this trigger to add tabs to a tabsheets
trigger trigger_action array include\functions_plugins.inc.php (trigger_event, trigger_action)
user_comment_check trigger_event string $comment_action, array $comm include\functions_comment.inc.php (insert_user_comment, update_user_comment) use this trigger to add conditions on comment validation
user_comment_deletion trigger_action mixed $comment_id include\functions_comment.inc.php (delete_user_comment) $comment_id is and int or an array of int
user_comment_insertion trigger_action array $comm include\picture_comment.inc.php
user_comment_validation trigger_action mixed $comment_id include\functions_comment.inc.php (validate_user_comment) $comment_id is and int or an array of int
user_init trigger_action array $user include\user.inc.php
ws_add_methods trigger_action object $this include\ws_core.inc.php (PwgServer::run)
ws_invoke_allowed trigger_event bool , string $methodName, array $params include\ws_core.inc.php (PwgServer::invoke)
user_logout trigger_action int $user_id include\functions_user.inc.php (logout_user)
user_login trigger_action int $user_id include\functions_user.inc.php (log_user)
try_log_user trigger_event boolean $success, string $username, string $password, bool $remember_me include\functions_user.inc.php (try_log_user) Used by identification form to check user credentials and log user. If success is true, another login method already succeed. Return true if your method succeed.