Hooks List » History » Version 16

Mischa The Evil, 2010-06-26 04:17

1 16 Mischa The Evil
h1. Redmine plugin hooks list
2 1 Jean-Philippe Lang
3 13 Mischa The Evil
{{>toc}}
4 2 Eric Davis
5 13 Mischa The Evil
To see the current list of plugin hooks, run @rake redmine:plugins:hook_list@ in the Redmine directory.
6 1 Jean-Philippe Lang
7 14 Mischa The Evil
h2. Controller hooks
8 14 Mischa The Evil
9 14 Mischa The Evil
table{width:100%}.
10 14 Mischa The Evil
|_. Name|_. Description|_. Context|
11 14 Mischa The Evil
|@:controller_account_success_authentication_after@| |@:user@|
12 14 Mischa The Evil
|@:controller_custom_fields_new_after_save@| |@:params, :custom_field@|
13 14 Mischa The Evil
|@:controller_custom_fields_edit_after_save@| |@:params, :custom_field@|
14 14 Mischa The Evil
|@:controller_issues_bulk_edit_before_save@|Passes the current issue and the params to the hook before saving. This can be used to set attributes on the issues.|@:params, :issue@|
15 15 Jie Ma
|@:controller_issues_new_before_save@| |@:params, :issue@|
16 14 Mischa The Evil
|@:controller_issues_new_after_save@| |@:params, :issue@|
17 14 Mischa The Evil
|@:controller_issues_edit_before_save@| |@:params, :issue, :time_entry, :journal@|
18 14 Mischa The Evil
|@:controller_issues_edit_after_save@| |@:params, :issue, :time_entry, :journal@|
19 15 Jie Ma
|@:controller_issues_move_before_save@| |@:params, :issue, :copy, :target_project@|
20 14 Mischa The Evil
|@:controller_journals_edit_post@| |@:params, :journal@|
21 14 Mischa The Evil
|@:controller_messages_new_after_save@| |@:params, :message@|
22 14 Mischa The Evil
|@:controller_messages_reply_after_save@| |@:params, :message@|
23 14 Mischa The Evil
|@:controller_timelog_edit_before_save@| |@:params, :time_entry@|
24 14 Mischa The Evil
|@:controller_wiki_edit_after_save@| |@:params, :page@|
25 14 Mischa The Evil
26 14 Mischa The Evil
h2. Helper hooks
27 14 Mischa The Evil
28 14 Mischa The Evil
table{width:100%}.
29 14 Mischa The Evil
|_. Name|_. Description|_. Context|
30 14 Mischa The Evil
|@:helper_issues_show_detail_after_setting@|Passes data to the hook to allow it to set the label and value.|@:detail, :label, :value, :old_value@|
31 14 Mischa The Evil
32 14 Mischa The Evil
h2. Model hooks
33 14 Mischa The Evil
34 14 Mischa The Evil
table{width:100%}.
35 14 Mischa The Evil
|_. Name|_. Description|_. Context|
36 14 Mischa The Evil
|@:model_changeset_scan_commit_for_issue_ids_pre_issue_update@| |@:changeset, :issue@|
37 14 Mischa The Evil
|@:model_project_copy_before_save@| |@:source_project, :destination_project@|
38 14 Mischa The Evil
39 13 Mischa The Evil
h2. View hooks
40 1 Jean-Philippe Lang
41 13 Mischa The Evil
The current project is accessible using the @:project@ key of the context for all the view hooks.
42 13 Mischa The Evil
43 3 Eric Davis
table{width:100%}.
44 1 Jean-Philippe Lang
|_. Name|_. Description|_. Context|
45 14 Mischa The Evil
|@:view_account_left_bottom@| |@:user@|
46 14 Mischa The Evil
|@:view_account_right_bottom@| |@:user@|
47 15 Jie Ma
|@:view_account_login_top@| |(none)|
48 15 Jie Ma
|@:view_account_login_bottom@| |(none)|
49 11 Mischa The Evil
|@:view_custom_fields_form_upper_box@| |@:custom_field, :form@|
50 11 Mischa The Evil
|@:"view_custom_fields_form_#{@custom_field.type.to_s.underscore}"@| |@:custom_field, :form@|
51 11 Mischa The Evil
|@:view_issue_statuses_form@| |@:issue_status@|
52 11 Mischa The Evil
|@:view_issues_bulk_edit_details_bottom@|Appends content to the bulk edit form before the note|@:issues@|
53 5 Eric Davis
|@:view_issues_edit_notes_bottom@| |@:issue, :notes, :form@|
54 1 Jean-Philippe Lang
|@:view_issues_form_details_bottom@|Appends content to the html table at the bottom of the issue form|@:issue, :form@|
55 12 Mischa The Evil
|@:view_issues_history_journal_bottom@| |@:journal@|
56 12 Mischa The Evil
|@:view_issues_show_details_bottom@|Appends content to the bottom of the issues details table|@:issue@|
57 1 Jean-Philippe Lang
|@:view_issues_sidebar_issues_bottom@| |(none)|
58 11 Mischa The Evil
|@:view_issues_sidebar_planning_bottom@| |(none)|
59 1 Jean-Philippe Lang
|@:view_issues_sidebar_queries_bottom@| |(none)|
60 11 Mischa The Evil
|@:view_issues_context_menu_start@| |@:issues, :can, :back@|
61 12 Mischa The Evil
|@:view_issues_context_menu_end@| |@:issues, :can, :back@|
62 12 Mischa The Evil
|@:view_issues_show_description_bottom@| |@:issue@|
63 15 Jie Ma
|@:view_issues_move_bottom@| |@:issue, :target_project, :copy@|
64 2 Eric Davis
|@:view_journals_notes_form_after_notes@| |@:journal@|
65 13 Mischa The Evil
|@:view_journals_update_rjs_bottom@| |@:page, :journal@|
66 1 Jean-Philippe Lang
|@:view_layouts_base_body_bottom@|Appends content to the end of the body section of the base layout|(none)|
67 1 Jean-Philippe Lang
|@:view_layouts_base_content@| |(none)|
68 1 Jean-Philippe Lang
|@:view_layouts_base_html_head@|Appends content to the html head of the base layout|(none)|
69 11 Mischa The Evil
|@:view_layouts_base_sidebar@| |(none)|
70 11 Mischa The Evil
|@:view_my_account@| |@:user, :form@|
71 15 Jie Ma
|@:view_my_account_contextual@| |@:user@|
72 1 Jean-Philippe Lang
|@:view_projects_form@| |@:project, :form@|
73 13 Mischa The Evil
|@:view_projects_roadmap_version_bottom@| |@:version@|
74 11 Mischa The Evil
|@:view_projects_settings_members_table_header@|Appends content to the table header of a Project's Member setting|@:project@|
75 11 Mischa The Evil
|@:view_projects_settings_members_table_row@|Appends content to the table row of a Project's Member setting|@:member, :project@|
76 11 Mischa The Evil
|@:view_projects_show_left@| |@:project@|
77 1 Jean-Philippe Lang
|@:view_projects_show_right@| |@:project@|
78 15 Jie Ma
|@:view_projects_show_sidebar_bottom@| |@:project@|
79 2 Eric Davis
|@:view_repositories_show_contextual@|Appends content to the contextual menu in the Repositories pane|@:project, :repository@|
80 13 Mischa The Evil
|@:view_timelog_edit_form_bottom@| |@:time_entry, :form@|
81 15 Jie Ma
|@:view_settings_general_form@| |(none)|
82 15 Jie Ma
|@:view_users_memberships_table_header@| |@:user@|
83 15 Jie Ma
|@:view_users_memberships_table_row@| |@:user, :membership, :roles, :projects@|
84 2 Eric Davis
|@:view_users_form@| |@:user, :form@|
85 3 Eric Davis
|@:view_versions_show_bottom@| |@:version@|
86 14 Mischa The Evil
|@:view_versions_show_contextual@| |@:version, :project@|
87 2 Eric Davis
|@:view_welcome_index_left@| |@:project@|
88 2 Eric Davis
|@:view_welcome_index_right@| |@:project@|
89 7 Eric Davis
90 13 Mischa The Evil
h2. Other hooks
91 7 Eric Davis
92 7 Eric Davis
table{width:100%}.
93 7 Eric Davis
|_. Name|_. Description|_. Context|