Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
/my/ -> index.php (source)
<?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/>.

/**
 * My Moodle -- a user's personal dashboard
 *
 * - each user can currently have their own page (cloned from system and then customised)
 * - only the user can see their own dashboard
 * - users can add any blocks they want
 * - the administrators can define a default site dashboard for users who have
 *   not created their own dashboard
 *
 * This script implements the user's view of the dashboard, and allows editing
 * of the dashboard.
 *
 * @package    moodlecore
 * @subpackage my
 * @copyright  2010 Remote-Learner.net
 * @author     Hubert Chathi <hubert@remote-learner.net>
 * @author     Olav Jordan <olav.jordan@remote-learner.net>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

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

redirect_if_major_upgrade_required();

// TODO Add sesskey check to edit
$edit   = optional_param('edit', null, PARAM_BOOL);    // Turn editing on and off
$reset  = optional_param('reset', null, PARAM_BOOL);

require_login();

$hassiteconfig = has_capability('moodle/site:config', context_system::instance());
if ($hassiteconfig && moodle_needs_upgrading()) {
    redirect(new moodle_url('/admin/index.php'));
}

$strmymoodle = get_string('myhome');

> if (empty($CFG->enabledashboard)) { if (isguestuser()) { // Force them to see system default, no editing allowed > // Dashboard is disabled, so the /my page shouldn't be displayed. // If guests are not allowed my moodle, send them to front page. > $defaultpage = get_default_home_page(); if (empty($CFG->allowguestmymoodle)) { > if ($defaultpage == HOMEPAGE_MYCOURSES) { redirect(new moodle_url('/', array('redirect' => 0))); > // If default page is set to "My courses", redirect to it. } > redirect(new moodle_url('/my/courses.php')); > } else { $userid = null; > // Otherwise, raise an exception to inform the dashboard is disabled. $USER->editing = $edit = 0; // Just in case > throw new moodle_exception('error:dashboardisdisabled', 'my'); $context = context_system::instance(); > } $PAGE->set_blocks_editing_capability('moodle/my:configsyspages'); // unlikely :) > } $strguest = get_string('guest'); >
< $header = "$SITE->shortname: $strmymoodle ($strguest)"; < $pagetitle = $header;
> $pagetitle = "$strmymoodle ($strguest)";
} else { // We are trying to view or edit our own My Moodle page $userid = $USER->id; // Owner of the page $context = context_user::instance($USER->id); $PAGE->set_blocks_editing_capability('moodle/my:manageblocks');
< $header = "$SITE->shortname: $strmymoodle";
$pagetitle = $strmymoodle; } // Get the My Moodle page info. Should always return something unless the database is broken. if (!$currentpage = my_get_page($userid, MY_PAGE_PRIVATE)) {
< print_error('mymoodlesetup');
> throw new \moodle_exception('mymoodlesetup');
} // Start setting up the page $params = array(); $PAGE->set_context($context); $PAGE->set_url('/my/index.php', $params); $PAGE->set_pagelayout('mydashboard');
> $PAGE->add_body_class('limitedwidth');
$PAGE->set_pagetype('my-index'); $PAGE->blocks->add_region('content'); $PAGE->set_subpage($currentpage->id); $PAGE->set_title($pagetitle);
< $PAGE->set_heading($header);
> $PAGE->set_heading($pagetitle);
if (!isguestuser()) { // Skip default home page for guests if (get_home_page() != HOMEPAGE_MY) { if (optional_param('setdefaulthome', false, PARAM_BOOL)) { set_user_preference('user_home_page_preference', HOMEPAGE_MY); } else if (!empty($CFG->defaulthomepage) && $CFG->defaulthomepage == HOMEPAGE_USER) { $frontpagenode = $PAGE->settingsnav->add(get_string('frontpagesettings'), null, navigation_node::TYPE_SETTING, null); $frontpagenode->force_open(); $frontpagenode->add(get_string('makethismyhome'), new moodle_url('/my/', array('setdefaulthome' => true)), navigation_node::TYPE_SETTING); } } } // Toggle the editing state and switches if (empty($CFG->forcedefaultmymoodle) && $PAGE->user_allowed_editing()) { if ($reset !== null) { if (!is_null($userid)) { require_sesskey(); if (!$currentpage = my_reset_page($userid, MY_PAGE_PRIVATE)) {
< print_error('reseterror', 'my');
> throw new \moodle_exception('reseterror', 'my');
} redirect(new moodle_url('/my')); } } else if ($edit !== null) { // Editing state was specified $USER->editing = $edit; // Change editing state } else { // Editing state is in session if ($currentpage->userid) { // It's a page we can edit, so load from session if (!empty($USER->editing)) { $edit = 1; } else { $edit = 0; } } else { // For the page to display properly with the user context header the page blocks need to // be copied over to the user context. if (!$currentpage = my_copy_page($USER->id, MY_PAGE_PRIVATE)) {
< print_error('mymoodlesetup');
> throw new \moodle_exception('mymoodlesetup');
} $context = context_user::instance($USER->id); $PAGE->set_context($context); $PAGE->set_subpage($currentpage->id); // It's a system page and they are not allowed to edit system pages $USER->editing = $edit = 0; // Disable editing completely, just to be safe } } // Add button for editing page $params = array('edit' => !$edit); $resetbutton = ''; $resetstring = get_string('resetpage', 'my'); $reseturl = new moodle_url("$CFG->wwwroot/my/index.php", array('edit' => 1, 'reset' => 1)); if (!$currentpage->userid) { // viewing a system page -- let the user customise it $editstring = get_string('updatemymoodleon'); $params['edit'] = 1; } else if (empty($edit)) { $editstring = get_string('updatemymoodleon'); } else { $editstring = get_string('updatemymoodleoff'); $resetbutton = $OUTPUT->single_button($reseturl, $resetstring); } $url = new moodle_url("$CFG->wwwroot/my/index.php", $params);
> $button = ''; $button = $OUTPUT->single_button($url, $editstring); > if (!$PAGE->theme->haseditswitch) {
$PAGE->set_button($resetbutton . $button);
> }
} else { $USER->editing = $edit = 0; } echo $OUTPUT->header(); if (core_userfeedback::should_display_reminder()) { core_userfeedback::print_reminder_block(); }
> > echo $OUTPUT->addblockbutton('content');
echo $OUTPUT->custom_block_region('content'); echo $OUTPUT->footer(); // Trigger dashboard has been viewed event. $eventparams = array('context' => $context); $event = \core\event\dashboard_viewed::create($eventparams); $event->trigger();