MDL-44467 core: always send email from noreplyaddress
[moodle.git] / mod / forum / upgrade.txt
CommitLineData
afd5e85c
RT
1This files describes API changes in /mod/forum/*,
2information provided here is intended especially for developers.
3
d16185fd 4=== 3.2 ===
253ae230
SL
5 * The setting $CFG->forum_replytouser has been deprecated in favour of a centralized noreplyaddress setting.
6 Please use $CFG->noreplyaddress setting instead.
d16185fd
AN
7 * The following functions have been finally deprecated and should no longer be used.
8 - forum_count_unrated_posts
9 - forum_tp_count_discussion_read_records
10 - forum_get_user_discussions
11 - forum_tp_count_forum_posts
12 - forum_tp_count_forum_read_records
13 - forum_get_open_modes
14 - forum_get_child_posts
15 - forum_get_discussion_posts
16 - forum_get_ratings
17 - forum_get_tracking_link
18 - forum_tp_count_discussion_unread_posts
19 - forum_convert_to_roles
20 - forum_tp_get_read_records
21 - forum_tp_get_discussion_read_records
22 - forum_user_enrolled
23 - forum_user_can_view_post
24 - forum_shorten_post
25 - forum_is_subscribed
26 - forum_subscribe
27 - forum_unsubscribe
28 - forum_subscribed_users
29 - forum_is_forcesubscribed
30 - forum_forcesubscribe
31 - forum_get_forcesubscribed
32 - forum_get_subscribed_forums
33 - forum_get_optional_subscribed_forums
34 - forum_get_potential_subscribers
14590070
JL
35 * External functions that were returning file information now return the following file fields:
36 filename, filepath, mimetype, filesize, timemodified and fileurl.
37 Those fields are now marked as VALUE_OPTIONAL for backwards compatibility.
d16185fd 38
54dceeed
BH
39=== 3.1 ===
40 * The inteface to forum_get_email_message_id() has changed and no longer needs the $host argument.
41
ea5b910b
JL
42=== 3.0 ===
43 * External function get_forums_by_courses now returns and additional field "cancreatediscussions" that indicates if the user
44 can create discussions in the forum.
4f3a2d21
JL
45 * A new optional parameter (groupid) has been added to get_forum_discussions.
46 This parameter can override the automatically calculated current group.
47 * New constant FORUM_POSTS_ALL_USER_GROUPS, to be used as parameter in functions where we'd need to retrieve all the user posts.
ea5b910b 48
39de876c
AN
49=== 2.8 ===
50 * The following functions have all been marked as deprecated. Many of
df7a4d65 51 these have not been supported in many releases and should not be relied
39de876c
AN
52 upon:
53 forum_count_unrated_posts
54 forum_tp_count_discussion_read_records
55 forum_get_user_discussions
56 forum_tp_count_forum_posts
57 forum_tp_count_forum_read_records
58 forum_get_open_modes
59 forum_get_child_posts
60 forum_get_discussion_posts
61 forum_get_ratings
62 forum_get_tracking_link
63 forum_tp_count_discussion_unread_posts
64 forum_convert_to_roles
65 forum_tp_get_read_records
66 forum_tp_get_discussion_read_records
67 forum_user_enrolled
68 forum_user_can_view_post
59075a43
AN
69 * The following functions have been deprecated and replaced. Please see the phpdoc for each on the new function to use instead:
70 * forum_is_subscribed
71 * forum_subscribe
72 * forum_unsubscribe
73 * forum_subscribed_users
74 * forum_is_forcesubscribed
75 * forum_forcesubscribe
76 * forum_get_forcesubscribed
77 * forum_get_subscribed_forums
78 * forum_get_optional_subscribed_forums
79 * forum_get_potential_subscribers
b235aef0
JL
80 * External function mod_forum_external::get_forum_discussions has been deprecated.
81 Use mod_forum_external::get_forum_discussions_paginated instead.
39de876c 82
2ecd2847
FM
83=== 2.6 ===
84
85* The file post_form.php should not be included, the class it contained has
86 been moved so that it can benefit from autoloading.
02d10ca0
MR
87* The function forum_shorten_post() has been deprecated. It was doing a poor
88 job of shortening forum post text and the shorten_text() function does a
89 much better job.
bd8f5d45
EM
90* The constant FORUM_TRACKING_ON has been depreciated and replaced by
91 FORUM_TRACKING_FORCED. The value between them is maintained, so they are
92 interchangeable, but code should migrate to the new name.
2ecd2847 93
f5ad424b
MN
94=== 2.5 ===
95
96The function forum_check_throttling has been changed so that a warning object is returned when a user has reached the 'Post threshold for warning' or
97'Post threshold for blocking' setting, rather than echoing this on screen. This allows the warning to be moved inside the post form as it can be added
98as a HTML element, where it is more noticeable. False is returned if there is no need to warn, or restrict the user from posting - see MDL-39182.
afd5e85c
RT
99
100=== 2.3.5, 2.4.2 ===
f5ad424b 101
afd5e85c
RT
102* mod/forum:allowforcesubscribe capability will be forcefully assigned to frontpage role, as it was mistakenly missed off
103when the capability was initially created. If you don't want users with frontpage role to get forum (with forcesubscribe) emails,
2ecd2847 104then please remove this capability for frontpage role.