Your content goes here. Edit or remove this text inline or in the module Content settings. You can also style every aspect of this content in the module Design settings and even apply custom CSS to this text in the module Advanced settings.

The code below is provided for the How to create a child Theme for Moodle – Moodle Child Theme Worksop course.

To enrol in the course, please go to https://ricoshae.teachable.com/p/moodle-child-theme-workshop

Course name
How to create a child Theme for Moodle – Moodle Child Theme Worksop

Subtitle
In this course I will take you step by step through the process to create a child theme based on the Moodle Boost theme.

Description
In this course I will take you step by step through the process to create a child theme based on the Moodle Boost theme. 

We will cover:

  • How to create the child theme.
  • How to install the child theme.
  • Making theme development easier
  • Test the child theme
  • How to add CSS to the child theme
  • How to override templates

This course will be presented using Moodle 3.7 and will use the Boost theme as a basis for the Moodle child theme. 

The concept of this course is for you to learn quickly and put your learning into practice straight away. As a result, there will be technical terminology that you may not understand and there will be some information that is not explained in detail because it requires its own course. In these cases I will try to provide you with additional information or a place to find the additional information so that you can move on quickly to achieving your goals of learning how to create a child theme. 


 

Lesson 2: How to create the child theme

The code below goes into the  /themes/ricoshae/config.php file.

<?php

// Every file should have GPL and copyright in the header - we skip it in tutorials but you should not skip it for real.

// This line protects the file from being accessed by a URL directly.
defined('MOODLE_INTERNAL') || die();

// $THEME is defined before this page is included and we can define settings by adding properties to this global object.
$THEME->doctype = 'html5';
// The first setting we need is the name of the theme. This should be the last part of the component name, and the same
// as the directory name for our theme.
$THEME->name = 'ricoshae';

// This setting list the style sheets we want to include in our theme. Because we want to use SCSS instead of CSS - we won't
// list any style sheets. If we did we would list the name of a file in the /style/ folder for our theme without any css file
// extensions.
$THEME->sheets = ['default'];

// This is a setting that can be used to provide some styling to the content in the TinyMCE text editor. This is no longer the
// default text editor and "Atto" does not need this setting so we won't provide anything. If we did it would work the same
// as the previous setting - listing a file in the /styles/ folder.
$THEME->editor_sheets = [];

// This is a critical setting. We want to inherit from theme_boost because it provides a great starting point for SCSS bootstrap4
// themes. We could add more than one parent here to inherit from multiple parents, and if we did they would be processed in
// order of importance (later themes overriding earlier ones). Things we will inherit from the parent theme include
// styles and mustache templates and some (not all) settings.
$THEME->parents = ['boost'];

//$THEME->hidefromselector = false;

// A dock is a way to take blocks out of the page and put them in a persistent floating area on the side of the page. Boost
// does not support a dock so we won't either - but look at bootstrapbase for an example of a theme with a dock.
$THEME->enable_dock = false;

// This is an old setting used to load specific CSS for some YUI JS. We don't need it in Boost based themes because Boost
// provides default styling for the YUI modules that we use. It is not recommended to use this setting anymore.
$THEME->yuicssmodules = array();

// Most themes will use this rendererfactory as this is the one that allows the theme to override any other renderer.
$THEME->rendererfactory = 'theme_overridden_renderer_factory';

// This is a list of blocks that are required to exist on all pages for this theme to function correctly. For example
// bootstrap base requires the settings and navigation blocks because otherwise there would be no way to navigate to all the
// pages in Moodle. Boost does not require these blocks because it provides other ways to navigate built into the theme.
$THEME->requiredblocks = '';

// This is a feature that tells the blocks library not to use the "Add a block" block. We don't want this in boost based themes because
// it forces a block region into the page when editing is enabled and it takes up too much room.
$THEME->addblockposition = BLOCK_ADDBLOCK_POSITION_FLATNAV;

$THEME->hidefromselector = false;

 


 

 Lesson 5: Steps 4 and 5  

The code below goes into the  /themes/ricoshae/version.php file. 

<?php
// Every file should have GPL and copyright in the header - we skip it in tutorials but you should not skip it for real.

// This line protects the file from being accessed by a URL directly.
defined('MOODLE_INTERNAL') || die();

// This is the version of the plugin.
$plugin->version = '2019052000';

// This is the version of Moodle this plugin requires.
$plugin->requires = '2019052002';
 
// This is the component name of the plugin - it always starts with 'theme_'
// for themes and should be the same as the name of the folder.
$plugin->component = 'theme_ricoshae';

// This is a list of plugins, this plugin depends on (and their versions).
$plugin->dependencies = [
    'theme_boost' => '2019052000'
];

 


 

Lesson 6: Steps 6 to 9 

The code below goes into the /theme/ricoshae/lang/en/theme_ricoshae.php file.

<?php
// Every file should have GPL and copyright in the header - we skip it in tutorials but you should not skip it for real.

// This line protects the file from being accessed by a URL directly.
defined('MOODLE_INTERNAL') || die();

// A description shown in the admin theme selector.
$string['choosereadme'] = 'Theme ricoshae is a child theme of Boost.';
// The name of our plugin.
$string['pluginname'] = 'ricoshae';