76d66dedf9444c04786c1ee3ed4127d62382759a
[moodle.git] / mod / forum / upgrade.txt
1 This files describes API changes in /mod/forum/*,
2 information provided here is intended especially for developers.
4 === 2.8 ===
5  * The following functions have all been marked as deprecated. Many of
6    these have not been supported in many releases and should not be relied
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
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
36 === 2.6 ===
38 * The file post_form.php should not be included, the class it contained has
39   been moved so that it can benefit from autoloading.
40 * The function forum_shorten_post() has been deprecated. It was doing a poor
41   job of shortening forum post text and the shorten_text() function does a
42   much better job.
43 * The constant FORUM_TRACKING_ON has been depreciated and replaced by
44   FORUM_TRACKING_FORCED. The value between them is maintained, so they are
45   interchangeable, but code should migrate to the new name.
47 === 2.5 ===
49 The 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
50 '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
51 as 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.
53 === 2.3.5, 2.4.2 ===
55 * mod/forum:allowforcesubscribe capability will be forcefully assigned to frontpage role, as it was mistakenly missed off
56 when the capability was initially created. If you don't want users with frontpage role to get forum (with forcesubscribe) emails,
57 then please remove this capability for frontpage role.