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
39de876c
AN
4=== 2.8 ===
5 * The following functions have all been marked as deprecated. Many of
df7a4d65 6 these have not been supported in many releases and should not be relied
39de876c
AN
7 upon:
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
59075a43
AN
24 * The following functions have been deprecated and replaced. Please see the phpdoc for each on the new function to use instead:
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
b235aef0
JL
35 * External function mod_forum_external::get_forum_discussions has been deprecated.
36 Use mod_forum_external::get_forum_discussions_paginated instead.
39de876c 37
2ecd2847
FM
38=== 2.6 ===
39
40* The file post_form.php should not be included, the class it contained has
41 been moved so that it can benefit from autoloading.
02d10ca0
MR
42* The function forum_shorten_post() has been deprecated. It was doing a poor
43 job of shortening forum post text and the shorten_text() function does a
44 much better job.
bd8f5d45
EM
45* The constant FORUM_TRACKING_ON has been depreciated and replaced by
46 FORUM_TRACKING_FORCED. The value between them is maintained, so they are
47 interchangeable, but code should migrate to the new name.
2ecd2847 48
f5ad424b
MN
49=== 2.5 ===
50
51The 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
52'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
53as 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
54
55=== 2.3.5, 2.4.2 ===
f5ad424b 56
afd5e85c
RT
57* mod/forum:allowforcesubscribe capability will be forcefully assigned to frontpage role, as it was mistakenly missed off
58when the capability was initially created. If you don't want users with frontpage role to get forum (with forcesubscribe) emails,
2ecd2847 59then please remove this capability for frontpage role.