Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
<?php

// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * Subscribe to or unsubscribe from a forum or manage forum subscription mode
 *
 * This script can be used by either individual users to subscribe to or
 * unsubscribe from a forum (no 'mode' param provided), or by forum managers
 * to control the subscription mode (by 'mode' param).
 * This script can be called from a link in email so the sesskey is not
 * required parameter. However, if sesskey is missing, the user has to go
 * through a confirmation page that redirects the user back with the
 * sesskey.
 *
 * @package   mod_forum
 * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

require(__DIR__.'/../../config.php');
require_once($CFG->dirroot.'/mod/forum/lib.php');

$id             = required_param('id', PARAM_INT);             // The forum to set subscription on.
$mode           = optional_param('mode', null, PARAM_INT);     // The forum's subscription mode.
$user           = optional_param('user', 0, PARAM_INT);        // The userid of the user to subscribe, defaults to $USER.
$discussionid   = optional_param('d', null, PARAM_INT);        // The discussionid to subscribe.
$sesskey        = optional_param('sesskey', null, PARAM_RAW);
$returnurl      = optional_param('returnurl', null, PARAM_LOCALURL);
$edit           = optional_param('edit', 'off', PARAM_ALPHANUM);

$url = new moodle_url('/mod/forum/subscribe.php', array('id'=>$id));
if (!is_null($mode)) {
    $url->param('mode', $mode);
}
if ($user !== 0) {
    $url->param('user', $user);
}
if (!is_null($sesskey)) {
    $url->param('sesskey', $sesskey);
}
if (!is_null($discussionid)) {
    $url->param('d', $discussionid);
    if (!$discussion = $DB->get_record('forum_discussions', array('id' => $discussionid, 'forum' => $id))) {
< print_error('invaliddiscussionid', 'forum');
> throw new \moodle_exception('invaliddiscussionid', 'forum');
} } $PAGE->set_url($url); $forum = $DB->get_record('forum', array('id' => $id), '*', MUST_EXIST); $course = $DB->get_record('course', array('id' => $forum->course), '*', MUST_EXIST); $cm = get_coursemodule_from_instance('forum', $forum->id, $course->id, false, MUST_EXIST); $context = context_module::instance($cm->id); if ($user) { require_sesskey(); if (!has_capability('mod/forum:managesubscriptions', $context)) {
< print_error('nopermissiontosubscribe', 'forum');
> throw new \moodle_exception('nopermissiontosubscribe', 'forum');
} $user = $DB->get_record('user', array('id' => $user), '*', MUST_EXIST); } else { $user = $USER; } if (isset($cm->groupmode) && empty($course->groupmodeforce)) { $groupmode = $cm->groupmode; } else { $groupmode = $course->groupmode; } $issubscribed = \mod_forum\subscriptions::is_subscribed($user->id, $forum, $discussionid, $cm); // For a user to subscribe when a groupmode is set, they must have access to at least one group. if ($groupmode && !$issubscribed && !has_capability('moodle/site:accessallgroups', $context)) { if (!groups_get_all_groups($course->id, $USER->id)) {
< print_error('cannotsubscribe', 'forum');
> throw new \moodle_exception('cannotsubscribe', 'forum');
} } require_login($course, false, $cm); if (is_null($mode) and !is_enrolled($context, $USER, '', true)) { // Guests and visitors can't subscribe - only enrolled $PAGE->set_title($course->shortname); $PAGE->set_heading($course->fullname); if (isguestuser()) { echo $OUTPUT->header(); echo $OUTPUT->confirm(get_string('subscribeenrolledonly', 'forum').'<br /><br />'.get_string('liketologin'), get_login_url(), new moodle_url('/mod/forum/view.php', array('f'=>$id))); echo $OUTPUT->footer(); exit; } else { // There should not be any links leading to this place, just redirect. redirect( new moodle_url('/mod/forum/view.php', array('f'=>$id)), get_string('subscribeenrolledonly', 'forum'), null, \core\output\notification::NOTIFY_ERROR ); } } $returnto = optional_param('backtoindex',0,PARAM_INT) ? "index.php?id=".$course->id : "view.php?f=$id"; if ($returnurl) { $returnto = $returnurl; } $subscribersurl = new moodle_url('/mod/forum/subscribers.php', ['id' => $id, 'edit' => $edit]); if (!is_null($mode) and has_capability('mod/forum:managesubscriptions', $context)) { require_sesskey(); switch ($mode) { case FORUM_CHOOSESUBSCRIBE : // 0 \mod_forum\subscriptions::set_subscription_mode($forum->id, FORUM_CHOOSESUBSCRIBE); redirect( $subscribersurl, get_string('everyonecannowchoose', 'forum'), null, \core\output\notification::NOTIFY_SUCCESS ); break; case FORUM_FORCESUBSCRIBE : // 1 \mod_forum\subscriptions::set_subscription_mode($forum->id, FORUM_FORCESUBSCRIBE); redirect( $subscribersurl, get_string('everyoneisnowsubscribed', 'forum'), null, \core\output\notification::NOTIFY_SUCCESS ); break; case FORUM_INITIALSUBSCRIBE : // 2 \mod_forum\subscriptions::set_subscription_mode($forum->id, FORUM_INITIALSUBSCRIBE); if ($forum->forcesubscribe <> FORUM_INITIALSUBSCRIBE) { // Reload the forum again to get the updated forcesubscribe field. $forum = $DB->get_record('forum', array('id' => $id), '*', MUST_EXIST); $users = \mod_forum\subscriptions::get_potential_subscribers($context, 0, 'u.id, u.email', ''); foreach ($users as $user) { \mod_forum\subscriptions::subscribe_user($user->id, $forum, $context); } } redirect( $subscribersurl, get_string('everyoneisnowsubscribed', 'forum'), null, \core\output\notification::NOTIFY_SUCCESS ); break; case FORUM_DISALLOWSUBSCRIBE : // 3 \mod_forum\subscriptions::set_subscription_mode($forum->id, FORUM_DISALLOWSUBSCRIBE); redirect( $subscribersurl, get_string('noonecansubscribenow', 'forum'), null, \core\output\notification::NOTIFY_SUCCESS ); break; default:
< print_error(get_string('invalidforcesubscribe', 'forum'));
> throw new \moodle_exception(get_string('invalidforcesubscribe', 'forum'));
} } if (\mod_forum\subscriptions::is_forcesubscribed($forum)) { $subscribersurl->param('notification', 'everyoneisnowsubscribed'); redirect($subscribersurl); } $info = new stdClass(); $info->name = fullname($user); $info->forum = format_string($forum->name); if ($issubscribed) { if (is_null($sesskey)) { // We came here via link in email. $PAGE->set_title($course->shortname); $PAGE->set_heading($course->fullname); echo $OUTPUT->header(); $viewurl = new moodle_url('/mod/forum/view.php', array('f' => $id)); if ($discussionid) { $a = new stdClass(); $a->forum = format_string($forum->name); $a->discussion = format_string($discussion->name); echo $OUTPUT->confirm(get_string('confirmunsubscribediscussion', 'forum', $a), $PAGE->url, $viewurl); } else { echo $OUTPUT->confirm(get_string('confirmunsubscribe', 'forum', format_string($forum->name)), $PAGE->url, $viewurl); } echo $OUTPUT->footer(); exit; } require_sesskey(); if ($discussionid === null) { if (\mod_forum\subscriptions::unsubscribe_user($user->id, $forum, $context, true)) { redirect( $returnto, get_string('nownotsubscribed', 'forum', $info), null, \core\output\notification::NOTIFY_SUCCESS ); } else {
< print_error('cannotunsubscribe', 'forum', get_local_referer(false));
> throw new \moodle_exception('cannotunsubscribe', 'forum', get_local_referer(false));
} } else { if (\mod_forum\subscriptions::unsubscribe_user_from_discussion($user->id, $discussion, $context)) { $info->discussion = $discussion->name; redirect( $returnto, get_string('discussionnownotsubscribed', 'forum', $info), null, \core\output\notification::NOTIFY_SUCCESS ); } else {
< print_error('cannotunsubscribe', 'forum', get_local_referer(false));
> throw new \moodle_exception('cannotunsubscribe', 'forum', get_local_referer(false));
} } } else { // subscribe if (\mod_forum\subscriptions::subscription_disabled($forum) && !has_capability('mod/forum:managesubscriptions', $context)) {
< print_error('disallowsubscribe', 'forum', get_local_referer(false));
> throw new \moodle_exception('disallowsubscribe', 'forum', get_local_referer(false));
} if (!has_capability('mod/forum:viewdiscussion', $context)) {
< print_error('noviewdiscussionspermission', 'forum', get_local_referer(false));
> throw new \moodle_exception('noviewdiscussionspermission', 'forum', get_local_referer(false));
} if (is_null($sesskey)) { // We came here via link in email. $PAGE->set_title($course->shortname); $PAGE->set_heading($course->fullname); echo $OUTPUT->header(); $viewurl = new moodle_url('/mod/forum/view.php', array('f' => $id)); if ($discussionid) { $a = new stdClass(); $a->forum = format_string($forum->name); $a->discussion = format_string($discussion->name); echo $OUTPUT->confirm(get_string('confirmsubscribediscussion', 'forum', $a), $PAGE->url, $viewurl); } else { echo $OUTPUT->confirm(get_string('confirmsubscribe', 'forum', format_string($forum->name)), $PAGE->url, $viewurl); } echo $OUTPUT->footer(); exit; } require_sesskey(); if ($discussionid == null) { \mod_forum\subscriptions::subscribe_user($user->id, $forum, $context, true); redirect( $returnto, get_string('nowsubscribed', 'forum', $info), null, \core\output\notification::NOTIFY_SUCCESS ); } else { $info->discussion = $discussion->name; \mod_forum\subscriptions::subscribe_user_to_discussion($user->id, $discussion, $context); redirect( $returnto, get_string('discussionnowsubscribed', 'forum', $info), null, \core\output\notification::NOTIFY_SUCCESS ); } }