Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.

Differences Between: [Versions 310 and 311] [Versions 310 and 400] [Versions 310 and 401] [Versions 310 and 402] [Versions 310 and 403]

   1  <?php
   2  
   3  // This file defines settingpages and externalpages under the "appearance" category
   4  
   5  $capabilities = array(
   6      'moodle/my:configsyspages',
   7      'moodle/tag:manage'
   8  );
   9  
  10  if ($hassiteconfig or has_any_capability($capabilities, $systemcontext)) { // speedup for non-admins, add all caps used on this page
  11  
  12      $ADMIN->add('appearance', new admin_category('themes', new lang_string('themes')));
  13      // "themesettings" settingpage
  14      $temp = new admin_settingpage('themesettings', new lang_string('themesettings', 'admin'));
  15      $setting = new admin_setting_configtext('themelist', new lang_string('themelist', 'admin'),
  16          new lang_string('configthemelist', 'admin'), '', PARAM_NOTAGS);
  17      $setting->set_force_ltr(true);
  18      $temp->add($setting);
  19      $setting = new admin_setting_configcheckbox('themedesignermode', new lang_string('themedesignermode', 'admin'), new lang_string('configthemedesignermode', 'admin'), 0);
  20      $setting->set_updatedcallback('theme_reset_all_caches');
  21      $temp->add($setting);
  22      $temp->add(new admin_setting_configcheckbox('allowuserthemes', new lang_string('allowuserthemes', 'admin'), new lang_string('configallowuserthemes', 'admin'), 0));
  23      $temp->add(new admin_setting_configcheckbox('allowcoursethemes', new lang_string('allowcoursethemes', 'admin'), new lang_string('configallowcoursethemes', 'admin'), 0));
  24      $temp->add(new admin_setting_configcheckbox('allowcategorythemes',  new lang_string('allowcategorythemes', 'admin'), new lang_string('configallowcategorythemes', 'admin'), 0));
  25      $temp->add(new admin_setting_configcheckbox('allowcohortthemes',  new lang_string('allowcohortthemes', 'admin'), new lang_string('configallowcohortthemes', 'admin'), 0));
  26      $temp->add(new admin_setting_configcheckbox('allowthemechangeonurl',  new lang_string('allowthemechangeonurl', 'admin'), new lang_string('configallowthemechangeonurl', 'admin'), 0));
  27      $temp->add(new admin_setting_configcheckbox('allowuserblockhiding', new lang_string('allowuserblockhiding', 'admin'), new lang_string('configallowuserblockhiding', 'admin'), 1));
  28      $temp->add(new admin_setting_configcheckbox('langmenuinsecurelayout',
  29          new lang_string('langmenuinsecurelayout', 'admin'),
  30          new lang_string('langmenuinsecurelayout_desc', 'admin'), 0));
  31      $temp->add(new admin_setting_configcheckbox('logininfoinsecurelayout',
  32          new lang_string('logininfoinsecurelayout', 'admin'),
  33          new lang_string('logininfoinsecurelayout_desc', 'admin'), 0));
  34      $temp->add(new admin_setting_configtextarea('custommenuitems', new lang_string('custommenuitems', 'admin'),
  35          new lang_string('configcustommenuitems', 'admin'), '', PARAM_RAW, '50', '10'));
  36      $temp->add(new admin_setting_configtextarea(
  37          'customusermenuitems',
  38          new lang_string('customusermenuitems', 'admin'),
  39          new lang_string('configcustomusermenuitems', 'admin'),
  40          'grades,grades|/grade/report/mygrades.php|t/grades
  41  messages,message|/message/index.php|t/message
  42  preferences,moodle|/user/preferences.php|t/preferences',
  43          PARAM_RAW,
  44          '50',
  45          '10'
  46      ));
  47      $temp->add(new admin_setting_configcheckbox('enabledevicedetection', new lang_string('enabledevicedetection', 'admin'), new lang_string('configenabledevicedetection', 'admin'), 1));
  48      $temp->add(new admin_setting_devicedetectregex('devicedetectregex', new lang_string('devicedetectregex', 'admin'), new lang_string('devicedetectregex_desc', 'admin'), ''));
  49      $ADMIN->add('themes', $temp);
  50      $ADMIN->add('themes', new admin_externalpage('themeselector', new lang_string('themeselector','admin'), $CFG->wwwroot . '/theme/index.php'));
  51  
  52      // settings for each theme
  53      foreach (core_component::get_plugin_list('theme') as $theme => $themedir) {
  54          $settings_path = "$themedir/settings.php";
  55          if (file_exists($settings_path)) {
  56              $settings = new admin_settingpage('themesetting'.$theme, new lang_string('pluginname', 'theme_'.$theme));
  57              include($settings_path);
  58              if ($settings) {
  59                  $ADMIN->add('themes', $settings);
  60              }
  61          }
  62      }
  63  
  64      // Logos section.
  65      $temp = new admin_settingpage('logos', new lang_string('logossettings', 'admin'));
  66  
  67      // Logo file setting.
  68      $title = get_string('logo', 'admin');
  69      $description = get_string('logo_desc', 'admin');
  70      $setting = new admin_setting_configstoredfile('core_admin/logo', $title, $description, 'logo', 0,
  71          ['maxfiles' => 1, 'accepted_types' => ['.jpg', '.png']]);
  72      $setting->set_updatedcallback('theme_reset_all_caches');
  73      $temp->add($setting);
  74  
  75      // Small logo file setting.
  76      $title = get_string('logocompact', 'admin');
  77      $description = get_string('logocompact_desc', 'admin');
  78      $setting = new admin_setting_configstoredfile('core_admin/logocompact', $title, $description, 'logocompact', 0,
  79          ['maxfiles' => 1, 'accepted_types' => ['.jpg', '.png']]);
  80      $setting->set_updatedcallback('theme_reset_all_caches');
  81      $temp->add($setting);
  82  
  83      $ADMIN->add('appearance', $temp);
  84  
  85      // Course colours section.
  86      $temp = new admin_settingpage('coursecolors', new lang_string('coursecolorsettings', 'admin'));
  87      $temp->add(new admin_setting_heading('coursecolorheading', '',
  88          new lang_string('coursecolorheading_desc', 'admin')));
  89  
  90      $basecolors = ['#81ecec', '#74b9ff', '#a29bfe', '#dfe6e9', '#00b894',
  91              '#0984e3', '#b2bec3', '#fdcb6e', '#fd79a8', '#6c5ce7'];
  92  
  93      foreach ($basecolors as $key => $color) {
  94          $number = $key + 1;
  95          $name = 'core_admin/coursecolor' . $number;
  96          $title = get_string('coursecolor', 'admin', $number);
  97          $setting = new admin_setting_configcolourpicker($name, $title, '', $color);
  98          $temp->add($setting);
  99      }
 100  
 101      $ADMIN->add('appearance', $temp);
 102  
 103      // Calendar settings.
 104      $temp = new admin_settingpage('calendar', new lang_string('calendarsettings','admin'));
 105  
 106      $temp->add(new admin_setting_configselect('calendartype', new lang_string('calendartype', 'admin'),
 107          new lang_string('calendartype_desc', 'admin'), 'gregorian', \core_calendar\type_factory::get_list_of_calendar_types()));
 108      $temp->add(new admin_setting_special_adminseesall());
 109      //this is hacky because we do not want to include the stuff from calendar/lib.php
 110      $temp->add(new admin_setting_configselect('calendar_site_timeformat', new lang_string('pref_timeformat', 'calendar'),
 111                                                new lang_string('explain_site_timeformat', 'calendar'), '0',
 112                                                array('0'        => new lang_string('default', 'calendar'),
 113                                                      '%I:%M %p' => new lang_string('timeformat_12', 'calendar'),
 114                                                      '%H:%M'    => new lang_string('timeformat_24', 'calendar'))));
 115      $temp->add(new admin_setting_configselect('calendar_startwday', new lang_string('configstartwday', 'admin'),
 116          new lang_string('helpstartofweek', 'admin'), get_string('firstdayofweek', 'langconfig'),
 117      array(
 118              0 => new lang_string('sunday', 'calendar'),
 119              1 => new lang_string('monday', 'calendar'),
 120              2 => new lang_string('tuesday', 'calendar'),
 121              3 => new lang_string('wednesday', 'calendar'),
 122              4 => new lang_string('thursday', 'calendar'),
 123              5 => new lang_string('friday', 'calendar'),
 124              6 => new lang_string('saturday', 'calendar')
 125          )));
 126      $temp->add(new admin_setting_special_calendar_weekend());
 127      $options = array(365 => new lang_string('numyear', '', 1),
 128              270 => new lang_string('nummonths', '', 9),
 129              180 => new lang_string('nummonths', '', 6),
 130              150 => new lang_string('nummonths', '', 5),
 131              120 => new lang_string('nummonths', '', 4),
 132              90  => new lang_string('nummonths', '', 3),
 133              60  => new lang_string('nummonths', '', 2),
 134              30  => new lang_string('nummonth', '', 1),
 135              21  => new lang_string('numweeks', '', 3),
 136              14  => new lang_string('numweeks', '', 2),
 137              7  => new lang_string('numweek', '', 1),
 138              6  => new lang_string('numdays', '', 6),
 139              5  => new lang_string('numdays', '', 5),
 140              4  => new lang_string('numdays', '', 4),
 141              3  => new lang_string('numdays', '', 3),
 142              2  => new lang_string('numdays', '', 2),
 143              1  => new lang_string('numday', '', 1));
 144      $temp->add(new admin_setting_configselect('calendar_lookahead', new lang_string('configlookahead', 'admin'), new lang_string('helpupcominglookahead', 'admin'), 21, $options));
 145      $options = array();
 146      for ($i=1; $i<=20; $i++) {
 147          $options[$i] = $i;
 148      }
 149      $temp->add(new admin_setting_configselect('calendar_maxevents',new lang_string('configmaxevents','admin'),new lang_string('helpupcomingmaxevents', 'admin'),10,$options));
 150      $temp->add(new admin_setting_configcheckbox('enablecalendarexport', new lang_string('enablecalendarexport', 'admin'), new lang_string('configenablecalendarexport','admin'), 1));
 151  
 152      // Calendar custom export settings.
 153      $days = array(365 => new lang_string('numdays', '', 365),
 154              180 => new lang_string('numdays', '', 180),
 155              150 => new lang_string('numdays', '', 150),
 156              120 => new lang_string('numdays', '', 120),
 157              90  => new lang_string('numdays', '', 90),
 158              60  => new lang_string('numdays', '', 60),
 159              30  => new lang_string('numdays', '', 30),
 160              5  => new lang_string('numdays', '', 5));
 161      $temp->add(new admin_setting_configcheckbox('calendar_customexport', new lang_string('configcalendarcustomexport', 'admin'), new lang_string('helpcalendarcustomexport','admin'), 1));
 162      $temp->add(new admin_setting_configselect('calendar_exportlookahead', new lang_string('configexportlookahead','admin'), new lang_string('helpexportlookahead', 'admin'), 365, $days));
 163      $temp->add(new admin_setting_configselect('calendar_exportlookback', new lang_string('configexportlookback','admin'), new lang_string('helpexportlookback', 'admin'), 5, $days));
 164      $temp->add(new admin_setting_configtext('calendar_exportsalt', new lang_string('calendarexportsalt','admin'), new lang_string('configcalendarexportsalt', 'admin'), random_string(60)));
 165      $temp->add(new admin_setting_configcheckbox('calendar_showicalsource', new lang_string('configshowicalsource', 'admin'), new lang_string('helpshowicalsource','admin'), 1));
 166      $ADMIN->add('appearance', $temp);
 167  
 168      // blog
 169      $temp = new admin_settingpage('blog', new lang_string('blog','blog'), 'moodle/site:config', empty($CFG->enableblogs));
 170      $temp->add(new admin_setting_configcheckbox('useblogassociations', new lang_string('useblogassociations', 'blog'), new lang_string('configuseblogassociations','blog'), 1));
 171      $temp->add(new admin_setting_bloglevel('bloglevel', new lang_string('bloglevel', 'admin'), new lang_string('configbloglevel', 'admin'), 4, array(BLOG_GLOBAL_LEVEL => new lang_string('worldblogs','blog'),
 172                                                                                                                                             BLOG_SITE_LEVEL => new lang_string('siteblogs','blog'),
 173                                                                                                                                             BLOG_USER_LEVEL => new lang_string('personalblogs','blog'))));
 174      $temp->add(new admin_setting_configcheckbox('useexternalblogs', new lang_string('useexternalblogs', 'blog'), new lang_string('configuseexternalblogs','blog'), 1));
 175      $temp->add(new admin_setting_configselect('externalblogcrontime', new lang_string('externalblogcrontime', 'blog'), new lang_string('configexternalblogcrontime', 'blog'), 86400,
 176          array(43200 => new lang_string('numhours', '', 12),
 177                86400 => new lang_string('numhours', '', 24),
 178                172800 => new lang_string('numdays', '', 2),
 179                604800 => new lang_string('numdays', '', 7))));
 180      $temp->add(new admin_setting_configtext('maxexternalblogsperuser', new lang_string('maxexternalblogsperuser','blog'), new lang_string('configmaxexternalblogsperuser', 'blog'), 1));
 181      $temp->add(new admin_setting_configcheckbox('blogusecomments', new lang_string('enablecomments', 'admin'), new lang_string('configenablecomments', 'admin'), 1));
 182      $temp->add(new admin_setting_configcheckbox('blogshowcommentscount', new lang_string('showcommentscount', 'admin'), new lang_string('configshowcommentscount', 'admin'), 1));
 183      $ADMIN->add('appearance', $temp);
 184  
 185      // Navigation settings
 186      $temp = new admin_settingpage('navigation', new lang_string('navigation'));
 187      $choices = array(
 188          HOMEPAGE_SITE => new lang_string('site'),
 189          HOMEPAGE_MY => new lang_string('mymoodle', 'admin'),
 190          HOMEPAGE_USER => new lang_string('userpreference', 'admin')
 191      );
 192      $temp->add(new admin_setting_configselect('defaulthomepage', new lang_string('defaulthomepage', 'admin'),
 193              new lang_string('configdefaulthomepage', 'admin'), HOMEPAGE_MY, $choices));
 194      $temp->add(new admin_setting_configcheckbox('allowguestmymoodle', new lang_string('allowguestmymoodle', 'admin'), new lang_string('configallowguestmymoodle', 'admin'), 1));
 195      $temp->add(new admin_setting_configcheckbox('navshowfullcoursenames', new lang_string('navshowfullcoursenames', 'admin'), new lang_string('navshowfullcoursenames_help', 'admin'), 0));
 196      $temp->add(new admin_setting_configcheckbox('navshowcategories', new lang_string('navshowcategories', 'admin'), new lang_string('confignavshowcategories', 'admin'), 1));
 197      $temp->add(new admin_setting_configcheckbox('navshowmycoursecategories', new lang_string('navshowmycoursecategories', 'admin'), new lang_string('navshowmycoursecategories_help', 'admin'), 0));
 198      $temp->add(new admin_setting_configcheckbox('navshowallcourses', new lang_string('navshowallcourses', 'admin'), new lang_string('confignavshowallcourses', 'admin'), 0));
 199      $sortoptions = array(
 200          'sortorder' => new lang_string('sort_sortorder', 'admin'),
 201          'fullname' => new lang_string('sort_fullname', 'admin'),
 202          'shortname' => new lang_string('sort_shortname', 'admin'),
 203          'idnumber' => new lang_string('sort_idnumber', 'admin'),
 204      );
 205      $temp->add(new admin_setting_configselect('navsortmycoursessort', new lang_string('navsortmycoursessort', 'admin'), new lang_string('navsortmycoursessort_help', 'admin'), 'sortorder', $sortoptions));
 206      $temp->add(new admin_setting_configcheckbox('navsortmycourseshiddenlast',
 207              new lang_string('navsortmycourseshiddenlast', 'admin'),
 208              new lang_string('navsortmycourseshiddenlast_help', 'admin'),
 209              1));
 210      $temp->add(new admin_setting_configtext('navcourselimit', new lang_string('navcourselimit', 'admin'),
 211          new lang_string('confignavcourselimit', 'admin'), 10, PARAM_INT));
 212      $temp->add(new admin_setting_configcheckbox('usesitenameforsitepages', new lang_string('usesitenameforsitepages', 'admin'), new lang_string('configusesitenameforsitepages', 'admin'), 0));
 213      $temp->add(new admin_setting_configcheckbox('linkadmincategories', new lang_string('linkadmincategories', 'admin'), new lang_string('linkadmincategories_help', 'admin'), 1));
 214      $temp->add(new admin_setting_configcheckbox('linkcoursesections', new lang_string('linkcoursesections', 'admin'), new lang_string('linkcoursesections_help', 'admin'), 1));
 215      $temp->add(new admin_setting_configcheckbox('navshowfrontpagemods', new lang_string('navshowfrontpagemods', 'admin'), new lang_string('navshowfrontpagemods_help', 'admin'), 1));
 216      $temp->add(new admin_setting_configcheckbox('navadduserpostslinks', new lang_string('navadduserpostslinks', 'admin'), new lang_string('navadduserpostslinks_help', 'admin'), 1));
 217  
 218      $ADMIN->add('appearance', $temp);
 219  
 220      // "htmlsettings" settingpage
 221      $temp = new admin_settingpage('htmlsettings', new lang_string('htmlsettings', 'admin'));
 222      $temp->add(new admin_setting_configcheckbox('formatstringstriptags', new lang_string('stripalltitletags', 'admin'), new lang_string('configstripalltitletags', 'admin'), 1));
 223      $temp->add(new admin_setting_emoticons());
 224      $ADMIN->add('appearance', $temp);
 225      $ADMIN->add('appearance', new admin_externalpage('resetemoticons', new lang_string('emoticonsreset', 'admin'),
 226          new moodle_url('/admin/resetemoticons.php'), 'moodle/site:config', true));
 227  
 228      // "documentation" settingpage
 229      $temp = new admin_settingpage('documentation', new lang_string('moodledocs'));
 230      $temp->add(new admin_setting_configtext('docroot', new lang_string('docroot', 'admin'), new lang_string('configdocroot', 'admin'), 'https://docs.moodle.org', PARAM_URL));
 231      $ltemp = array('' => get_string('forceno'));
 232      $ltemp += get_string_manager()->get_list_of_translations(true);
 233      $temp->add(new admin_setting_configselect('doclang', get_string('doclang', 'admin'), get_string('configdoclang', 'admin'), '', $ltemp));
 234      $temp->add(new admin_setting_configcheckbox('doctonewwindow', new lang_string('doctonewwindow', 'admin'), new lang_string('configdoctonewwindow', 'admin'), 0));
 235      $ADMIN->add('appearance', $temp);
 236  
 237      $temp = new admin_externalpage('mypage', new lang_string('mypage', 'admin'), $CFG->wwwroot . '/my/indexsys.php',
 238              'moodle/my:configsyspages');
 239      $ADMIN->add('appearance', $temp);
 240  
 241      $temp = new admin_externalpage('profilepage', new lang_string('myprofile', 'admin'), $CFG->wwwroot . '/user/profilesys.php',
 242              'moodle/my:configsyspages');
 243      $ADMIN->add('appearance', $temp);
 244  
 245      // coursecontact is the person responsible for course - usually manages enrolments, receives notification, etc.
 246      $temp = new admin_settingpage('coursecontact', new lang_string('courses'));
 247      $temp->add(new admin_setting_special_coursecontact());
 248      $temp->add(new admin_setting_configcheckbox('coursecontactduplicates',
 249              new lang_string('coursecontactduplicates', 'admin'),
 250              new lang_string('coursecontactduplicates_desc', 'admin'), 0));
 251      $temp->add(new admin_setting_configcheckbox('courselistshortnames',
 252              new lang_string('courselistshortnames', 'admin'),
 253              new lang_string('courselistshortnames_desc', 'admin'), 0));
 254      $temp->add(new admin_setting_configtext('coursesperpage', new lang_string('coursesperpage', 'admin'), new lang_string('configcoursesperpage', 'admin'), 20, PARAM_INT));
 255      $temp->add(new admin_setting_configtext('courseswithsummarieslimit', new lang_string('courseswithsummarieslimit', 'admin'), new lang_string('configcourseswithsummarieslimit', 'admin'), 10, PARAM_INT));
 256      $temp->add(new admin_setting_configtext('courseoverviewfileslimit', new lang_string('courseoverviewfileslimit'),
 257              new lang_string('configcourseoverviewfileslimit', 'admin'), 1, PARAM_INT));
 258      $temp->add(new admin_setting_configtext('courseoverviewfilesext', new lang_string('courseoverviewfilesext'),
 259              new lang_string('configcourseoverviewfilesext', 'admin'), '.jpg,.gif,.png'));
 260      $temp->add(new admin_setting_configtext('coursegraceperiodbefore', new lang_string('coursegraceperiodbefore', 'admin'),
 261          new lang_string('configcoursegraceperiodbefore', 'admin'), 0, PARAM_INT));
 262      $temp->add(new admin_setting_configtext('coursegraceperiodafter', new lang_string('coursegraceperiodafter', 'admin'),
 263          new lang_string('configcoursegraceperiodafter', 'admin'), 0, PARAM_INT));
 264      $ADMIN->add('appearance', $temp);
 265  
 266      $temp = new admin_settingpage('ajax', new lang_string('ajaxuse'));
 267      $temp->add(new admin_setting_configcheckbox('useexternalyui', new lang_string('useexternalyui', 'admin'), new lang_string('configuseexternalyui', 'admin'), 0));
 268      $temp->add(new admin_setting_configcheckbox('yuicomboloading', new lang_string('yuicomboloading', 'admin'), new lang_string('configyuicomboloading', 'admin'), 1));
 269      $setting = new admin_setting_configcheckbox('cachejs', new lang_string('cachejs', 'admin'), new lang_string('cachejs_help', 'admin'), 1);
 270      $setting->set_updatedcallback('js_reset_all_caches');
 271      $temp->add($setting);
 272      $temp->add(new admin_setting_configcheckbox('modchooserdefault', new lang_string('modchooserdefault', 'admin'), new lang_string('configmodchooserdefault', 'admin'), 1));
 273      $ADMIN->add('appearance', $temp);
 274  
 275      // Link to tag management interface.
 276      $url = new moodle_url('/tag/manage.php');
 277      $hidden = empty($CFG->usetags);
 278      $page = new admin_externalpage('managetags', new lang_string('managetags', 'tag'), $url, 'moodle/tag:manage', $hidden);
 279      $ADMIN->add('appearance', $page);
 280  
 281      $temp = new admin_settingpage('additionalhtml', new lang_string('additionalhtml', 'admin'));
 282      $temp->add(new admin_setting_heading('additionalhtml_heading', new lang_string('additionalhtml_heading', 'admin'), new lang_string('additionalhtml_desc', 'admin')));
 283      $temp->add(new admin_setting_configtextarea('additionalhtmlhead', new lang_string('additionalhtmlhead', 'admin'), new lang_string('additionalhtmlhead_desc', 'admin'), '', PARAM_RAW));
 284      $temp->add(new admin_setting_configtextarea('additionalhtmltopofbody', new lang_string('additionalhtmltopofbody', 'admin'), new lang_string('additionalhtmltopofbody_desc', 'admin'), '', PARAM_RAW));
 285      $temp->add(new admin_setting_configtextarea('additionalhtmlfooter', new lang_string('additionalhtmlfooter', 'admin'), new lang_string('additionalhtmlfooter_desc', 'admin'), '', PARAM_RAW));
 286      $ADMIN->add('appearance', $temp);
 287  
 288      $setting = new admin_setting_configcheckbox('cachetemplates', new lang_string('cachetemplates', 'admin'),
 289          new lang_string('cachetemplates_help', 'admin'), 1);
 290      $setting->set_updatedcallback('template_reset_all_caches');
 291      $temp = new admin_settingpage('templates', new lang_string('templates', 'admin'));
 292      $temp->add($setting);
 293      $ADMIN->add('appearance', $temp);
 294  } // end of speedup