Speed Up Your Moodle Development with the Moodle Plugin Skeleton Generator
Hey everyone! Chris Richter here from Ricoshae.com.au.
Today, I want to share something I recently stumbled across and if you’re a Moodle developer, especially someone who builds plugins, you’re going to love this. It’s called the Moodle Plugin Skeleton Generator, and it’s a real time-saver.
If you’ve ever created a Moodle plugin before, you know that just getting started can be the most frustrating part. Knowing which files you need, understanding their structure, and setting up all the boilerplate code takes a lot of time and can sometimes feel overwhelming.
That’s where this tool comes in. The Moodle Plugin Skeleton Generator helps automate the setup of your plugin’s framework, so you can focus more on developing functionality and less on the tedious groundwork. Although it’s been around since Moodle 3.9, I’ve only just discovered it and honestly, I’m loving it so far.
Let me walk you through what it does and how you can get started:
Installing the Skeleton Generator
Once you’ve installed the tool on your server, you’ll find it under:
Site administration > Development > Generate plugin skeleton
(You’ll need admin rights to access this.)
From there, you’ll see a simple interface where you can choose the type of plugin you want to create. Whether it’s an activity module, admin tool, block, quiz type, or something else, the generator can handle it.
For this demonstration, I selected Local plugin because it’s one of the simplest types to create. I named my plugin Ricoshae Dev.
Filling in the Details
The plugin skeleton generator asks you for a few basic details, like:
- Component name (in my case:
local_ricoshaedev) - Copyright
- Version number
You can also choose to include extra files like:
- Install and uninstall scripts
- Settings files
- Language strings
- Dependencies (if your plugin relies on others)
- CLI scripts
- Capabilities and permissions
- Observers and events
- PHP unit tests setup
The tool even supports recipes templates you can download or create yourself for even more customized skeletons.
Generating the Skeleton
After filling in your details, you just click Download Plugin Skeleton, and voila – you get a neatly packaged ZIP file.
Inside the ZIP, you’ll find:
- A fully structured plugin folder
- DB install and uninstall scripts
- Language files with your custom strings
- A settings page ready to be customized
- Version.php with all the correct metadata
- License and README files
Basically, everything you need to get started is ready to go and properly formatted according to Moodle’s standards.
Why This Matters
Setting up a Moodle plugin manually usually involves creating a lot of repetitive boilerplate files. You have to constantly reference documentation to make sure you don’t miss anything. With the Moodle Plugin Skeleton Generator, you can skip that whole painful process and jump straight into building the features that matter.
It’s a huge boost for productivity, especially for developers who are working on multiple plugins or trying to learn Moodle plugin development.
If you’re a Moodle developer and you haven’t checked out the Moodle Plugin Skeleton Generator yet, I highly recommend you give it a try.
And if you’ve found any other helpful tools, tips, or tricks that make Moodle plugin development easier, I’d love to hear about them! Drop them in the comments, let’s share the knowledge and make Moodle development a little smoother for everyone.
Until next time, happy coding!