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