[Summary view] [Print] [Text view]

   1  This files describes API changes in /mod/forum/*,
   2  information provided here is intended especially for developers.
   3  
   4  === 3.2 ===
   5   * The following functions have been finally deprecated and should no longer be used.
   6    - forum_count_unrated_posts
   7    - forum_tp_count_discussion_read_records
   8    - forum_get_user_discussions
   9    - forum_tp_count_forum_posts
  10    - forum_tp_count_forum_read_records
  11    - forum_get_open_modes
  12    - forum_get_child_posts
  13    - forum_get_discussion_posts
  14    - forum_get_ratings
  15    - forum_get_tracking_link
  16    - forum_tp_count_discussion_unread_posts
  17    - forum_convert_to_roles
  18    - forum_tp_get_read_records
  19    - forum_tp_get_discussion_read_records
  20    - forum_user_enrolled
  21    - forum_user_can_view_post
  22    - forum_shorten_post
  23    - forum_is_subscribed
  24    - forum_subscribe
  25    - forum_unsubscribe
  26    - forum_subscribed_users
  27    - forum_is_forcesubscribed
  28    - forum_forcesubscribe
  29    - forum_get_forcesubscribed
  30    - forum_get_subscribed_forums
  31    - forum_get_optional_subscribed_forums
  32    - forum_get_potential_subscribers
  33   * External functions that were returning file information now return the following file fields:
  34     filename, filepath, mimetype, filesize, timemodified and fileurl.
  35     Those fields are now marked as VALUE_OPTIONAL for backwards compatibility.
  36  
  37  === 3.1 ===
  38   * The inteface to forum_get_email_message_id() has changed and no longer needs the $host argument.
  39  
  40  === 3.0 ===
  41   * External function get_forums_by_courses now returns and additional field "cancreatediscussions" that indicates if the user
  42     can create discussions in the forum.
  43   * A new optional parameter (groupid) has been added to get_forum_discussions.
  44     This parameter can override the automatically calculated current group.
  45   * New constant FORUM_POSTS_ALL_USER_GROUPS, to be used as parameter in functions where we'd need to retrieve all the user posts.
  46  
  47  === 2.8 ===
  48   * The following functions have all been marked as deprecated. Many of
  49     these have not been supported in many releases and should not be relied
  50     upon:
  51       forum_count_unrated_posts
  52       forum_tp_count_discussion_read_records
  53       forum_get_user_discussions
  54       forum_tp_count_forum_posts
  55       forum_tp_count_forum_read_records
  56       forum_get_open_modes
  57       forum_get_child_posts
  58       forum_get_discussion_posts
  59       forum_get_ratings
  60       forum_get_tracking_link
  61       forum_tp_count_discussion_unread_posts
  62       forum_convert_to_roles
  63       forum_tp_get_read_records
  64       forum_tp_get_discussion_read_records
  65       forum_user_enrolled
  66       forum_user_can_view_post
  67   * The following functions have been deprecated and replaced. Please see the phpdoc for each on the new function to use instead:
  68     * forum_is_subscribed
  69     * forum_subscribe
  70     * forum_unsubscribe
  71     * forum_subscribed_users
  72     * forum_is_forcesubscribed
  73     * forum_forcesubscribe
  74     * forum_get_forcesubscribed
  75     * forum_get_subscribed_forums
  76     * forum_get_optional_subscribed_forums
  77     * forum_get_potential_subscribers
  78   * External function mod_forum_external::get_forum_discussions has been deprecated.
  79     Use mod_forum_external::get_forum_discussions_paginated instead.
  80  
  81  === 2.6 ===
  82  
  83  * The file post_form.php should not be included, the class it contained has
  84    been moved so that it can benefit from autoloading.
  85  * The function forum_shorten_post() has been deprecated. It was doing a poor
  86    job of shortening forum post text and the shorten_text() function does a
  87    much better job.
  88  * The constant FORUM_TRACKING_ON has been depreciated and replaced by
  89    FORUM_TRACKING_FORCED. The value between them is maintained, so they are
  90    interchangeable, but code should migrate to the new name.
  91  
  92  === 2.5 ===
  93  
  94  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
  95  '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
  96  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.
  97  
  98  === 2.3.5, 2.4.2 ===
  99  
 100  * mod/forum:allowforcesubscribe capability will be forcefully assigned to frontpage role, as it was mistakenly missed off
 101  when the capability was initially created. If you don't want users with frontpage role to get forum (with forcesubscribe) emails,
 102  then please remove this capability for frontpage role.