weekly release 3.1dev
[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
ea5b910b
JL
4=== 3.0 ===
5 * External function get_forums_by_courses now returns and additional field "cancreatediscussions" that indicates if the user
6 can create discussions in the forum.
4f3a2d21
JL
7 * A new optional parameter (groupid) has been added to get_forum_discussions.
8 This parameter can override the automatically calculated current group.
9 * 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 10
39de876c
AN
11=== 2.8 ===
12 * The following functions have all been marked as deprecated. Many of
df7a4d65 13 these have not been supported in many releases and should not be relied
39de876c
AN
14 upon:
15 forum_count_unrated_posts
16 forum_tp_count_discussion_read_records
17 forum_get_user_discussions
18 forum_tp_count_forum_posts
19 forum_tp_count_forum_read_records
20 forum_get_open_modes
21 forum_get_child_posts
22 forum_get_discussion_posts
23 forum_get_ratings
24 forum_get_tracking_link
25 forum_tp_count_discussion_unread_posts
26 forum_convert_to_roles
27 forum_tp_get_read_records
28 forum_tp_get_discussion_read_records
29 forum_user_enrolled
30 forum_user_can_view_post
59075a43
AN
31 * The following functions have been deprecated and replaced. Please see the phpdoc for each on the new function to use instead:
32 * forum_is_subscribed
33 * forum_subscribe
34 * forum_unsubscribe
35 * forum_subscribed_users
36 * forum_is_forcesubscribed
37 * forum_forcesubscribe
38 * forum_get_forcesubscribed
39 * forum_get_subscribed_forums
40 * forum_get_optional_subscribed_forums
41 * forum_get_potential_subscribers
b235aef0
JL
42 * External function mod_forum_external::get_forum_discussions has been deprecated.
43 Use mod_forum_external::get_forum_discussions_paginated instead.
39de876c 44
2ecd2847
FM
45=== 2.6 ===
46
47* The file post_form.php should not be included, the class it contained has
48 been moved so that it can benefit from autoloading.
02d10ca0
MR
49* The function forum_shorten_post() has been deprecated. It was doing a poor
50 job of shortening forum post text and the shorten_text() function does a
51 much better job.
bd8f5d45
EM
52* The constant FORUM_TRACKING_ON has been depreciated and replaced by
53 FORUM_TRACKING_FORCED. The value between them is maintained, so they are
54 interchangeable, but code should migrate to the new name.
2ecd2847 55
f5ad424b
MN
56=== 2.5 ===
57
58The 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
59'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
60as 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
61
62=== 2.3.5, 2.4.2 ===
f5ad424b 63
afd5e85c
RT
64* mod/forum:allowforcesubscribe capability will be forcefully assigned to frontpage role, as it was mistakenly missed off
65when the capability was initially created. If you don't want users with frontpage role to get forum (with forcesubscribe) emails,
2ecd2847 66then please remove this capability for frontpage role.