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