Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
mod_forum

Topics

 backup
 
 
 cache
 
 
 event
 
 
 files
 
 
 log
 
 
 rss
 
 
 task
 
 
 test
 
 

Directories

directory analytics
  
 
directory backup
  
 
directory data_mappers
  
 
directory message
  
 
directory report
  
 

Namespaces

namespace  mod_forum
  
 
namespace  mod_forum\analytics\indicator
 Activity base class.
 
namespace  mod_forum\completion
  
 
namespace  mod_forum\event
 The mod_forum assessable uploaded event.
 
namespace  mod_forum\form
 This file contains the form definition for discussion export.
 
namespace  mod_forum\grades
  
 
namespace  mod_forum\h5p
  
 
namespace  mod_forum\local
 Container class.
 
namespace  mod_forum\local\builders
 Exported discussion builder class.
 
namespace  mod_forum\local\data_mappers\legacy
 Author data mapper.
 
namespace  mod_forum\local\entities
 Author class.
 
namespace  mod_forum\local\exporters
 Author exporter.
 
namespace  mod_forum\local\factories
 Builder factory.
 
namespace  mod_forum\local\managers
 Capability manager for the forum.
 
namespace  mod_forum\local\renderers
 Discussion renderer.
 
namespace  mod_forum\local\vaults
 Author vault class.
 
namespace  mod_forum\local\vaults\preprocessors
 Extract context vault preprocessor.
 
namespace  mod_forum\message\inbound
 A Handler to process replies to forum posts.
 
namespace  mod_forum\output
 Big search form.
 
namespace  mod_forum\output\courseformat
  
 
namespace  mod_forum\output\email
 Forum post renderable.
 
namespace  mod_forum\output\emaildigestbasic
 Forum post renderable.
 
namespace  mod_forum\output\emaildigestfull
 Forum post renderable.
 
namespace  mod_forum\plugininfo
 Subplugin info class.
 
namespace  mod_forum\privacy
 Privacy Subsystem implementation for mod_forum.
 
namespace  mod_forum\search
 Forum activities search area.
 
namespace  mod_forum\task
 A scheduled task for forum cron.
 

Classes

class  backup_forum_activity_structure_step
 Define all the backup steps that will be used by the backup_forum_activity_task. More...
 
class  mod_forum\analytics\indicator\activity_base
 Activity base class. More...
 
class  mod_forum\analytics\indicator\cognitive_depth
 Cognitive depth indicator - forum. More...
 
class  mod_forum\analytics\indicator\social_breadth
 Social breadth indicator - forum. More...
 
class  mod_forum\completion\custom_completion
 Activity custom completion subclass for the forum activity. More...
 
class  mod_forum\dates
 Class for fetching the important dates in mod_forum for a given module instance and a user. More...
 
class  mod_forum\event\assessable_uploaded
 The mod_forum assessable uploaded event class. More...
 
class  mod_forum\event\course_module_instance_list_viewed
 The mod_forum instance list viewed event class. More...
 
class  mod_forum\event\course_module_viewed
 The mod_forum course module viewed event class. More...
 
class  mod_forum\event\discussion_lock_updated
 The mod_forum discussion lock updated event. More...
 
class  mod_forum\event\discussion_moved
 The mod_forum discussion moved event class. More...
 
class  mod_forum\event\discussion_pinned
 The mod_forum discussion pinned event. More...
 
class  mod_forum\event\discussion_unpinned
 The mod_forum discussion unpinned event. More...
 
class  mod_forum\event\discussion_viewed
 The mod_forum discussion viewed event class. More...
 
class  mod_forum\event\readtracking_disabled
 The mod_forum subscription created event class. More...
 
class  mod_forum\event\readtracking_enabled
 The mod_forum read tracking enabled event class. More...
 
class  mod_forum\event\subscription_created
 The mod_forum subscription created event class. More...
 
class  mod_forum\event\subscription_deleted
 The mod_forum subscription deleted event class. More...
 
class  mod_forum\event\subscription_mode_updated
 The mod_forum subscription mode updated event. More...
 
class  mod_forum\event\user_report_viewed
 The mod_forum user report viewed event class. More...
 
class  mod_forum\form\export_form
 Export discussion form. More...
 
class  mod_forum\grades\forum_gradeitem
 Grade item storage for mod_forum. More...
 
class  mod_forum\grades\gradeitems
 Grade item mappings for the activity. More...
 
class  mod_forum\h5p\canedit
 Class to check if the H5P content can be edited for this plugin. More...
 
class  mod_forum\local\builders\exported_discussion
 Exported discussion builder class. More...
 
class  mod_forum\local\builders\exported_discussion_summaries
 Exported discussion summaries builder class. More...
 
class  mod_forum\local\builders\exported_posts
 Exported post builder class. More...
 
class  mod_forum\local\container
 Container class. More...
 
class  mod_forum\local\data_mappers\legacy\author
 Convert an author entity into an stdClass. More...
 
class  mod_forum\local\data_mappers\legacy\discussion
 Convert a discussion entity into an stdClass. More...
 
class  mod_forum\local\data_mappers\legacy\forum
 Convert a forum entity into an stdClass. More...
 
class  mod_forum\local\data_mappers\legacy\post
 Convert a post entity into an stdClass. More...
 
class  mod_forum\local\entities\author
 Author class. More...
 
class  mod_forum\local\entities\discussion
 Discussion class. More...
 
class  mod_forum\local\entities\discussion_summary
 Discussion summary class. More...
 
class  mod_forum\local\entities\forum
 Forum class. More...
 
class  mod_forum\local\entities\post
 Post class. More...
 
class  mod_forum\local\entities\post_read_receipt_collection
 Post read receipt collection class. More...
 
class  mod_forum\local\entities\sorter
 Class to sort lists of items. More...
 
class  mod_forum\local\exporters\author
 Author exporter. More...
 
class  mod_forum\local\exporters\discussion
 Discussion exporter class. More...
 
class  mod_forum\local\exporters\discussion_summaries
 Discussion summaries exporter. More...
 
class  mod_forum\local\exporters\discussion_summary
 Discussion summary exporter class. More...
 
class  mod_forum\local\exporters\forum
 Forum class. More...
 
class  mod_forum\local\exporters\group
 Group exporter. More...
 
class  mod_forum\local\exporters\post
 Post exporter class. More...
 
class  mod_forum\local\exporters\posts
 Posts exporter class. More...
 
class  mod_forum\local\factories\builder
 Builder factory to construct any builders for forum. More...
 
class  mod_forum\local\factories\entity
 Entity factory to create the forum entities. More...
 
class  mod_forum\local\factories\exporter
 The exporter factory class used to fetch an instance of the different exporter types. More...
 
class  mod_forum\local\factories\legacy_data_mapper
 Legacy data mapper factory. More...
 
class  mod_forum\local\factories\manager
 Managers factory. More...
 
class  mod_forum\local\factories\renderer
 Renderer factory. More...
 
class  mod_forum\local\factories\url
 A URL factory for the forum. More...
 
class  mod_forum\local\factories\vault
 Vault factory. More...
 
class  mod_forum\local\managers\capability
 Capability manager for the forum. More...
 
class  mod_forum\local\renderers\discussion
 Discussion renderer class. More...
 
class  mod_forum\local\renderers\discussion_list
 The discussion list renderer. More...
 
class  mod_forum\local\renderers\posts
 Posts renderer class. More...
 
class  mod_forum\local\vaults\author
 Author vault class. More...
 
class  mod_forum\local\vaults\db_table_vault
 Abstract class for loading records from the DB. More...
 
class  mod_forum\local\vaults\discussion
 Discussion vault class. More...
 
class  mod_forum\local\vaults\discussion_list
 Discussion list vault. More...
 
class  mod_forum\local\vaults\forum
 Forum vault class. More...
 
class  mod_forum\local\vaults\post
 Post vault class. More...
 
class  mod_forum\local\vaults\post_attachment
 Post attachment vault class. More...
 
class  mod_forum\local\vaults\post_read_receipt_collection
 Post read receipt collection class. More...
 
class  mod_forum\local\vaults\preprocessors\extract_context
 Extract context vault preprocessor. More...
 
class  mod_forum\local\vaults\preprocessors\extract_record
 Extract record vault preprocessor. More...
 
class  mod_forum\local\vaults\preprocessors\extract_user
 Extract user vault preprocessor. More...
 
class  mod_forum\message\inbound\reply_handler
 A Handler to process replies to forum posts. More...
 
class  mod_forum\output\big_search_form
 Big search form class. More...
 
class  mod_forum\output\courseformat\activitybadge
 Activity badge forum class, used for rendering unread messages. More...
 
class  mod_forum\output\email\renderer
 Forum post renderable. More...
 
class  mod_forum\output\email\renderer_textemail
 Forum post renderable. More...
 
class  mod_forum\output\emaildigestbasic\renderer
 Forum post renderable. More...
 
class  mod_forum\output\emaildigestbasic\renderer_textemail
 Forum post renderable. More...
 
class  mod_forum\output\emaildigestfull\renderer
 Forum post renderable. More...
 
class  mod_forum\output\emaildigestfull\renderer_textemail
 Forum post renderable. More...
 
class  mod_forum\output\forum_actionbar
 Render activity page for tertiary nav. More...
 
class  mod_forum\output\forum_post
 
class  mod_forum\output\forum_post_email
 Forum post renderable for use in e-mail. More...
 
class  mod_forum\output\quick_search_form
 Quick search form renderable class. More...
 
class  mod_forum\output\subscription_actionbar
 Renders the subscribers page for this activity. More...
 
class  mod_forum\plugininfo\forumreport
 Forum report subplugin info class. More...
 
class  mod_forum\privacy\provider
 Implementation of the privacy subsystem plugin provider for the forum activity module. More...
 
class  mod_forum\search\activity
 Forum activities search area. More...
 
class  mod_forum\search\post
 Forum posts search area. More...
 
class  mod_forum\subscriptions
 Forum subscription manager. More...
 
class  mod_forum\task\cron_task
 The main scheduled task for the forum. More...
 
class  mod_forum\task\send_user_digests
 Adhoc task to send moodle forum digests for the specified user. More...
 
class  mod_forum\task\send_user_notifications
 Adhoc task to send user forum notifications. More...
 
class  mod_forum_existing_subscriber_selector
 User selector control for removing subscribed users. More...
 
class  mod_forum_external
 External forum API. More...
 
class  mod_forum_mod_form
 
class  mod_forum_observer
 Event observer for mod_forum. More...
 
class  mod_forum_post_form
 Class to post in a forum. More...
 
class  mod_forum_potential_subscriber_selector
 A user selector control for potential subscribers to the selected forum. More...
 
class  mod_forum_prune_form
 Form which displays fields for splitting forum post to a separate threads. More...
 
class  mod_forum_renderer
 This file contains a custom renderer class used by the forum module. More...
 
class  mod_forum_subscriber_selector_base
 Abstract class used by forum subscriber selection controls. More...
 
class  moodle1_mod_forum_handler
 Forum conversion handler. More...
 
class  restore_forum_activity_structure_step
 Define all the restore steps that will be used by the restore_forum_activity_task. More...
 
class  restore_forum_activity_task
 forum restore task that provides all the settings and steps to perform one complete restore of the activity More...
 

Functions

 forum_convert_to_roles ()
 
 forum_count_replies ()
 
 forum_count_unrated_posts ()
 
 forum_cron ()
 
 forum_cron_minimise_user_record ()
 
 forum_forcesubscribe ($forumid, $value=1)
 
 forum_get_child_posts ()
 
 forum_get_completion_state ()
 
 forum_get_discussion_posts ()
 
 forum_get_forcesubscribed ($forum)
 
 forum_get_open_modes ()
 
 forum_get_optional_subscribed_forums ()
 
 forum_get_potential_subscribers ()
 
 forum_get_ratings ()
 
 forum_get_subscribed_forums ()
 
 forum_get_tracking_link ()
 
 forum_get_user_discussions ()
 
 forum_get_user_grades ()
 
 forum_is_forcesubscribed ($forum)
 Determine whether the forum is force subscribed.
 
 forum_is_subscribed ()
 
 forum_make_mail_html ()
 
 forum_make_mail_post ()
 
 forum_make_mail_text ()
 
 forum_post_nesting_cache ()
 
 forum_print_discussion ()
 
 forum_print_discussion_header ()
 This function prints the overview of a discussion in the forum listing.
 
 forum_print_latest_discussions ()
 
 forum_print_post ()
 
 forum_print_post_end ()
 
 forum_print_post_start ()
 
 forum_print_posts_flat ()
 
 forum_print_posts_nested ()
 
 forum_print_posts_threaded ()
 
 forum_scale_used ()
 
 forum_shorten_post ($message)
 
 forum_should_end_post_nesting ()
 
 forum_should_start_post_nesting ()
 
 forum_subscribe ()
 
 forum_subscribed_users ()
 
 forum_tp_count_discussion_read_records ()
 
 forum_tp_count_discussion_unread_posts ()
 
 forum_tp_count_forum_posts ()
 
 forum_tp_count_forum_read_records ()
 
 forum_tp_get_discussion_read_records ()
 
 forum_tp_get_read_records ()
 
 forum_unsubscribe ()
 
object forum_update_subscriptions_button ($courseid, $forumid)
 Prints the editing button on subscribers page.
 
 forum_user_can_view_post ()
 
 forum_user_enrolled ()
 
 xmldb_forum_upgrade ($oldversion)
 

Variables

 $capabilities
 
global mod_forum\local\entities::$CFG
 
global mod_forum\local\factories::$CFG
 
 $functions
 Forum external functions and service definitions.
 
 $handlers
 
 $messageproviders
 Defines message providers (types of messages being sent)
 
 $plugin = 2023100400
 
 $tagareas
 
$plugin component = 'mod_forum'
 
const FORUM_TRACKING_ON 2
 FORUM_TRACKING_ON - deprecated alias for FORUM_TRACKING_FORCED.
 
 if (!defined( 'MOODLE_INTERNAL'))
 This file provides form for splitting discussions.
 
 if (!defined( 'MOODLE_INTERNAL'))
 
$plugin version = 2023100901
 

Detailed Description

Function Documentation

◆ forum_convert_to_roles()

forum_convert_to_roles ( )
Deprecated
since Moodle 2.0 MDL-23479 - please do not use this function any more.

◆ forum_count_replies()

forum_count_replies ( )
Deprecated
since Moodle 3.7

◆ forum_count_unrated_posts()

forum_count_unrated_posts ( )
Deprecated
since Moodle 1.1 - please do not use this function any more.

◆ forum_cron()

forum_cron ( )
Deprecated
since Moodle 3.7

◆ forum_cron_minimise_user_record()

forum_cron_minimise_user_record ( )
Deprecated
since Moodle 3.7

◆ forum_forcesubscribe()

forum_forcesubscribe ( $forumid,
$value = 1 )

◆ forum_get_child_posts()

forum_get_child_posts ( )
Deprecated
since Moodle 1.9 MDL-13303 - please do not use this function any more.

◆ forum_get_completion_state()

forum_get_completion_state ( )
Deprecated
since Moodle 3.11

◆ forum_get_discussion_posts()

forum_get_discussion_posts ( )
Deprecated
since Moodle 1.9 MDL-13303 - please do not use this function any more.

◆ forum_get_forcesubscribed()

forum_get_forcesubscribed ( $forum)

◆ forum_get_open_modes()

forum_get_open_modes ( )
Deprecated
since Moodle 1.7 - please do not use this function any more.

◆ forum_get_optional_subscribed_forums()

forum_get_optional_subscribed_forums ( )

◆ forum_get_potential_subscribers()

forum_get_potential_subscribers ( )

◆ forum_get_ratings()

forum_get_ratings ( )
Deprecated
since Moodle 2.0 MDL-21657 - please do not use this function any more.

◆ forum_get_subscribed_forums()

forum_get_subscribed_forums ( )

◆ forum_get_tracking_link()

forum_get_tracking_link ( )
Deprecated
since Moodle 2.0 MDL-14632 - please do not use this function any more.

◆ forum_get_user_discussions()

forum_get_user_discussions ( )
Deprecated
since Moodle 1.5 - please do not use this function any more.

◆ forum_get_user_grades()

forum_get_user_grades ( )
Deprecated
since Moodle 3.8

◆ forum_is_forcesubscribed()

forum_is_forcesubscribed ( $forum)

Determine whether the forum is force subscribed.

Deprecated
since Moodle 2.8 use mod_forum\subscriptions\is_forcesubscribed() instead

◆ forum_is_subscribed()

forum_is_subscribed ( )

◆ forum_make_mail_html()

forum_make_mail_html ( )
Deprecated
since Moodle 3.0 use mod_forum\output\forum_post_email instead

◆ forum_make_mail_post()

forum_make_mail_post ( )
Deprecated
since Moodle 3.0 use mod_forum\output\forum_post_email instead

◆ forum_make_mail_text()

forum_make_mail_text ( )
Deprecated
since Moodle 3.0 use mod_forum\output\forum_post_email instead

◆ forum_post_nesting_cache()

forum_post_nesting_cache ( )
Deprecated
since Moodle 3.7

◆ forum_print_discussion()

forum_print_discussion ( )
Deprecated
since Moodle 3.7

◆ forum_print_discussion_header()

forum_print_discussion_header ( )

This function prints the overview of a discussion in the forum listing.

It needs some discussion information and some post information, these happen to be combined for efficiency in the $post parameter by the function that calls this one: forum_print_latest_discussions()

Deprecated
since Moodle 4.3

◆ forum_print_latest_discussions()

forum_print_latest_discussions ( )
Deprecated
since Moodle 3.7

◆ forum_print_post()

forum_print_post ( )
Deprecated
since Moodle 3.7

◆ forum_print_post_end()

forum_print_post_end ( )
Deprecated
since Moodle 3.7

◆ forum_print_post_start()

forum_print_post_start ( )
Deprecated
since Moodle 3.7

◆ forum_print_posts_flat()

forum_print_posts_flat ( )
Deprecated
since Moodle 3.7

◆ forum_print_posts_nested()

forum_print_posts_nested ( )
Deprecated
since Moodle 3.7

◆ forum_print_posts_threaded()

forum_print_posts_threaded ( )
Deprecated
since Moodle 3.7

◆ forum_scale_used()

forum_scale_used ( )
Deprecated
since Moodle 3.8

◆ forum_shorten_post()

forum_shorten_post ( $message)
Deprecated
since Moodle 2.6
See also
shorten_text()

◆ forum_should_end_post_nesting()

forum_should_end_post_nesting ( )
Deprecated
since Moodle 3.7

◆ forum_should_start_post_nesting()

forum_should_start_post_nesting ( )
Deprecated
since Moodle 3.7

◆ forum_subscribe()

forum_subscribe ( )

◆ forum_subscribed_users()

forum_subscribed_users ( )

◆ forum_tp_count_discussion_read_records()

forum_tp_count_discussion_read_records ( )
Deprecated
since Moodle 1.5 - please do not use this function any more.

◆ forum_tp_count_discussion_unread_posts()

forum_tp_count_discussion_unread_posts ( )
Deprecated
since Moodle 2.0 MDL-14113 - please do not use this function any more.

◆ forum_tp_count_forum_posts()

forum_tp_count_forum_posts ( )
Deprecated
since Moodle 1.6 - please do not use this function any more.

◆ forum_tp_count_forum_read_records()

forum_tp_count_forum_read_records ( )
Deprecated
since Moodle 1.6 - please do not use this function any more.

◆ forum_tp_get_discussion_read_records()

forum_tp_get_discussion_read_records ( )
Deprecated
since Moodle 2.0 MDL-14113 - please do not use this function any more.

◆ forum_tp_get_read_records()

forum_tp_get_read_records ( )
Deprecated
since Moodle 2.0 MDL-14113 - please do not use this function any more.

◆ forum_unsubscribe()

forum_unsubscribe ( )

◆ forum_update_subscriptions_button()

object forum_update_subscriptions_button ( $courseid,
$forumid )

Prints the editing button on subscribers page.

Deprecated
since Moodle 4.0
Todo
MDL-73956 Final deprecation in Moodle 4.4

@global object

Parameters
int$courseid
int$forumid
Return values
string

◆ forum_user_can_view_post()

forum_user_can_view_post ( )
Deprecated
since Moodle 2.4 use forum_user_can_see_post() instead

◆ forum_user_enrolled()

forum_user_enrolled ( )
Deprecated
since Moodle 2.3 MDL-33166 - please do not use this function any more.

Variable Documentation

◆ $functions

$functions

Forum external functions and service definitions.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

◆ $handlers

$handlers
Initial value:
= array(
array(
'classname' => '\mod_forum\message\inbound\reply_handler',
),
)

◆ $messageproviders

$messageproviders
Initial value:
= array (
'posts' => array(
'defaults' => array(
'airnotifier' => MESSAGE_PERMITTED + MESSAGE_DEFAULT_ENABLED,
),
),
'digests' => array(
),
)

Defines message providers (types of messages being sent)

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

◆ $tagareas

$tagareas
Initial value:
= array(
array(
'itemtype' => 'forum_posts',
'component' => 'mod_forum',
'callback' => 'mod_forum_get_tagged_posts',
'callbackfile' => '/mod/forum/locallib.php',
),
)

◆ FORUM_TRACKING_ON

const FORUM_TRACKING_ON 2

FORUM_TRACKING_ON - deprecated alias for FORUM_TRACKING_FORCED.

Deprecated
since 2.6

◆ if [1/2]

if(!defined('MOODLE_INTERNAL')) ( ! defined 'MOODLE_INTERNAL')

This file provides form for splitting discussions.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

◆ if [2/2]

if(!defined('MOODLE_INTERNAL')) ( ! defined 'MOODLE_INTERNAL')
License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later