Hooks List » History » Version 14

Mischa The Evil, 2009-07-26 22:29
Updated hooks with r2704, r2771, r2772, r2773, r2774 and r2775 on trunk.

1 13 Mischa The Evil
h1. Redmine plugin hooks
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 14 Mischa The Evil
|@:controller_issues_new_after_save@| |@:params, :issue@|
16 14 Mischa The Evil
|@:controller_issues_edit_before_save@| |@:params, :issue, :time_entry, :journal@|
17 14 Mischa The Evil
|@:controller_issues_edit_after_save@| |@:params, :issue, :time_entry, :journal@|
18 14 Mischa The Evil
|@:controller_journals_edit_post@| |@:params, :journal@|
19 14 Mischa The Evil
|@:controller_messages_new_after_save@| |@:params, :message@|
20 14 Mischa The Evil
|@:controller_messages_reply_after_save@| |@:params, :message@|
21 14 Mischa The Evil
|@:controller_timelog_edit_before_save@| |@:params, :time_entry@|
22 14 Mischa The Evil
|@:controller_wiki_edit_after_save@| |@:params, :page@|
23 14 Mischa The Evil
24 14 Mischa The Evil
h2. Helper hooks
25 14 Mischa The Evil
26 14 Mischa The Evil
table{width:100%}.
27 14 Mischa The Evil
|_. Name|_. Description|_. Context|
28 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@|
29 14 Mischa The Evil
30 14 Mischa The Evil
h2. Model hooks
31 14 Mischa The Evil
32 14 Mischa The Evil
table{width:100%}.
33 14 Mischa The Evil
|_. Name|_. Description|_. Context|
34 14 Mischa The Evil
|@:model_changeset_scan_commit_for_issue_ids_pre_issue_update@| |@:changeset, :issue@|
35 14 Mischa The Evil
|@:model_project_copy_before_save@| |@:source_project, :destination_project@|
36 14 Mischa The Evil
37 13 Mischa The Evil
h2. View hooks
38 1 Jean-Philippe Lang
39 13 Mischa The Evil
The current project is accessible using the @:project@ key of the context for all the view hooks.
40 13 Mischa The Evil
41 3 Eric Davis
table{width:100%}.
42 1 Jean-Philippe Lang
|_. Name|_. Description|_. Context|
43 14 Mischa The Evil
|@:view_account_left_bottom@| |@:user@|
44 14 Mischa The Evil
|@:view_account_right_bottom@| |@:user@|
45 11 Mischa The Evil
|@:view_custom_fields_form_upper_box@| |@:custom_field, :form@|
46 11 Mischa The Evil
|@:"view_custom_fields_form_#{@custom_field.type.to_s.underscore}"@| |@:custom_field, :form@|
47 11 Mischa The Evil
|@:view_issue_statuses_form@| |@:issue_status@|
48 11 Mischa The Evil
|@:view_issues_bulk_edit_details_bottom@|Appends content to the bulk edit form before the note|@:issues@|
49 5 Eric Davis
|@:view_issues_edit_notes_bottom@| |@:issue, :notes, :form@|
50 1 Jean-Philippe Lang
|@:view_issues_form_details_bottom@|Appends content to the html table at the bottom of the issue form|@:issue, :form@|
51 12 Mischa The Evil
|@:view_issues_history_journal_bottom@| |@:journal@|
52 12 Mischa The Evil
|@:view_issues_show_details_bottom@|Appends content to the bottom of the issues details table|@:issue@|
53 1 Jean-Philippe Lang
|@:view_issues_sidebar_issues_bottom@| |(none)|
54 11 Mischa The Evil
|@:view_issues_sidebar_planning_bottom@| |(none)|
55 1 Jean-Philippe Lang
|@:view_issues_sidebar_queries_bottom@| |(none)|
56 11 Mischa The Evil
|@:view_issues_context_menu_start@| |@:issues, :can, :back@|
57 12 Mischa The Evil
|@:view_issues_context_menu_end@| |@:issues, :can, :back@|
58 12 Mischa The Evil
|@:view_issues_show_description_bottom@| |@:issue@|
59 2 Eric Davis
|@:view_journals_notes_form_after_notes@| |@:journal@|
60 13 Mischa The Evil
|@:view_journals_update_rjs_bottom@| |@:page, :journal@|
61 1 Jean-Philippe Lang
|@:view_layouts_base_body_bottom@|Appends content to the end of the body section of the base layout|(none)|
62 1 Jean-Philippe Lang
|@:view_layouts_base_content@| |(none)|
63 1 Jean-Philippe Lang
|@:view_layouts_base_html_head@|Appends content to the html head of the base layout|(none)|
64 11 Mischa The Evil
|@:view_layouts_base_sidebar@| |(none)|
65 11 Mischa The Evil
|@:view_my_account@| |@:user, :form@|
66 1 Jean-Philippe Lang
|@:view_projects_form@| |@:project, :form@|
67 13 Mischa The Evil
|@:view_projects_roadmap_version_bottom@| |@:version@|
68 11 Mischa The Evil
|@:view_projects_settings_members_table_header@|Appends content to the table header of a Project's Member setting|@:project@|
69 11 Mischa The Evil
|@:view_projects_settings_members_table_row@|Appends content to the table row of a Project's Member setting|@:member, :project@|
70 11 Mischa The Evil
|@:view_projects_show_left@| |@:project@|
71 1 Jean-Philippe Lang
|@:view_projects_show_right@| |@:project@|
72 2 Eric Davis
|@:view_repositories_show_contextual@|Appends content to the contextual menu in the Repositories pane|@:project, :repository@|
73 13 Mischa The Evil
|@:view_timelog_edit_form_bottom@| |@:time_entry, :form@|
74 2 Eric Davis
|@:view_users_form@| |@:user, :form@|
75 3 Eric Davis
|@:view_versions_show_bottom@| |@:version@|
76 14 Mischa The Evil
|@:view_versions_show_contextual@| |@:version, :project@|
77 2 Eric Davis
|@:view_welcome_index_left@| |@:project@|
78 2 Eric Davis
|@:view_welcome_index_right@| |@:project@|
79 7 Eric Davis
80 13 Mischa The Evil
h2. Other hooks
81 7 Eric Davis
82 7 Eric Davis
table{width:100%}.
83 7 Eric Davis
|_. Name|_. Description|_. Context|