Hooks List » History » Version 13

Mischa The Evil, 2009-07-26 22:03
Small improvements and added right-aligned TOC (see diff for more info).

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