index.md

title	tags
Plugin types	Plugins core API

Moodle is a powerful, and very extensible, Learning Management System. One of its core tenets is its extensibility, and this is primarily achieved through the development of plugins.

A wider range of plugin types are available and these should be selected depending on your needs.

Things you can find in all plugins

Although there are many different types of plugin, there are some things that work the same way in all plugin types. Please see the Plugin files documentation that describes common files which are found in many plugin types.

Naming conventions

Plugins typically have at least two names:

• The friendly name, shown to users, and
• A machine name used internally.

The machine name must meet the following rules:

• It must start with a lowercase latin letter
• It may contain only lowercase latin letters, numbers, and underscores
• It must end with a lowercase latin letter, or a number
• The hyphen, and minus character - are not allowed

If a plugin does not meet these requirements then it will be silently ignored.

:::tip

Plugin name validation takes place in core_component::is_valid_plugin_name() and the following regular expression is used:

/^[a-z](?:[a-z0-9_](?!__))*[](a-z0-9)+$/

:::

:::danger Activity module exception

The underscore character is not supported in activity modules for legacy reasons.

:::

Plugin type	Component name (Frankenstyle)	Moodle path	Description	Moodle versions
Activity modules	mod	/mod	Activity modules are essential types of plugins in Moodle as they provide activities in courses. For example: Forum, Quiz and Assignment.	1.0+
Antivirus plugins	antivirus	/lib/antivirus	Antivirus scanner plugins provide functionality for virus scanning user uploaded files using third-party virus scanning tools in Moodle. For example: ClamAV.	3.1+
Assignment submission plugins	assignsubmission	/mod/assign/submission	Different forms of assignment submissions	2.3+
Assignment feedback plugins	assignfeedback	/mod/assign/feedback	Different forms of assignment feedbacks	2.3+
Book tools	booktool	/mod/book/tool	Small information-displays or tools that can be moved around pages	2.1+
Custom fields	customfield	/customfield/field	Custom field types, used in Custom course fields	3.7+
Database fields	datafield	/mod/data/field	Different types of data that may be added to the Database activity module	1.6+
Database presets	datapreset	/mod/data/preset	Pre-defined templates for the Database activity module	1.6+
LTI sources	ltisource	/mod/lti/source	LTI providers can be added to external tools easily through the external tools interface see Documentation on External Tools. This type of plugin is specific to LTI providers that need a plugin that can register custom handlers to process LTI messages	2.7+
File Converters	fileconverter	/files/converter	Allow conversion between different types of user-submitted file. For example from .doc to PDF.	3.2+
LTI services	ltiservice	/mod/lti/service	Allows the implementation of LTI services as described by the IMS LTI specification	2.8+
Machine learning backends	mlbackend	/lib/mlbackend	Prediction processors for analytics API	3.4+
Forum reports	forumreport	/mod/forum/report	Display various reports in the forum activity	3.8+
Quiz reports	quiz	/mod/quiz/report	Display and analyse the results of quizzes, or just plug miscellaneous behaviour into the quiz module	1.1+
Quiz access rules	quizaccess	/mod/quiz/accessrule	Add conditions to when or where quizzes can be attempted, for example only from some IP addresses, or student must enter a password first	2.2+
SCORM reports	scormreport	/mod/scorm/report	Analysis of SCORM attempts	2.2+
Workshop grading strategies	workshopform	/mod/workshop/form	Define the type of the grading form and implement the calculation of the grade for submission in the Workshop module	2.0+
Workshop allocation methods	workshopallocation	/mod/workshop/allocation	Define ways how submissions are assigned for assessment in the Workshop module	2.0+
Workshop evaluation methods	workshopeval	/mod/workshop/eval	Implement the calculation of the grade for assessment (grading grade) in the Workshop module	2.0+
Blocks	block	/blocks	Small information-displays or tools that can be moved around pages	2.0+
Question types	qtype	/question/type	Different types of question (for example multiple-choice, drag-and-drop) that can be used in quizzes and other activities	1.6+
Question behaviours	qbehaviour	/question/behaviour	Control how student interact with questions during an attempt	2.1+
Question import/export formats	qformat	/question/format	Import and export question definitions to/from the question bank	1.6+
Text filters	filter	/filter	Automatically convert, highlight, and transmogrify text posted into Moodle.	1.4+
Editors	editor	/lib/editor	Alternative text editors for editing content	2.0+
Atto editor plugins	atto	/lib/editor/atto/plugins	Extra functionality for the Atto text editor	2.7+
Enrolment plugins	enrol	/enrol	Ways to control who is enrolled in courses	2.0+
Authentication plugins	auth	/auth	Allows connection to external sources of authentication	2.0+
Admin tools	tool	/admin/tool	Provides utility scripts useful for various site administration and maintenance tasks	2.2+
Log stores	logstore	/admin/tool/log/store	Event logs storage back-ends	2.7+
Availability conditions	availability	/availability/condition	Conditions to restrict user access to activities and sections.	2.7+
Calendar types	calendartype	/calendar/type	Defines how dates are displayed throughout Moodle	2.6+
Messaging consumers	message	/message/output	Represent various targets where messages and notifications can be sent to (email, sms, jabber, ...)	2.0+
Course formats	format	/course/format	Different ways of laying out the activities and blocks in a course	1.3+
Data formats	dataformat	/dataformat	Formats for data exporting and downloading	3.1+
User profile fields	profilefield	/user/profile/field	Add new types of data to user profiles	1.9+
Reports	report	/report	Provides useful views of data in a Moodle site for admins and teachers	2.2+
Course reports	coursereport	/course/report	Reports of activity within the course	Up to 2.1 (for 2.2+ see Reports)
Gradebook export	gradeexport	/grade/export	Export grades in various formats	1.9+
Gradebook import	gradeimport	/grade/import	Import grades in various formats	1.9+
Gradebook reports	gradereport	/grade/report	Display/edit grades in various layouts and reports	1.9+
Advanced grading methods	gradingform	/grade/grading/form	Interfaces for actually performing grading in activity modules (for example Rubrics)	2.2+
MNet services	mnetservice	/mnet/service	Allows to implement remote services for the MNet environment (deprecated, use web services instead)	2.0+
Webservice protocols	webservice	/webservice	Define new protocols for web service communication (such as SOAP, XML-RPC, JSON, REST ...)	2.0+
Repository plugins	repository	/repository	Connect to external sources of files to use in Moodle	2.0+
Portfolio plugins	portfolio	/portfolio	Connect external portfolio services as destinations for users to store Moodle content	1.9+
Search engines	search	/search/engine	Search engine backends to index Moodle's contents.	3.1+
Media players	media	/media/player	Pluggable media players	3.2+
Plagiarism plugins	plagiarism	/plagiarism	Define external services to process submitted files and content	2.0+
Cache store	cachestore	/cache/stores	Cache storage back-ends.	2.4+
Cache locks	cachelock	/cache/locks	Cache lock implementations.	2.4+
Themes	theme	/theme	Change the look of Moodle by changing the the HTML and the CSS.	2.0+
Local plugins	local	/local	Generic plugins for local customisations	2.0+
Content bank content types	contenttype	/contentbank/contenttype	Content types to upload, create or edit in the content bank and use all over the Moodle site	3.9+
H5P libraries	h5plib	/h5p/h5plib	Plugin type for the particular versions of the H5P integration library.	3.9+
Question bank plugins	qbank	/question/bank	Plugin type for extending question bank functionality.	4.0+

Obtaining the list of plugin types known to your Moodle

You can get an exact list of valid plugin types for your Moodle version using the following example:

<?php
define('CLI_SCRIPT', true);
require('config.php');

$pluginman = core_plugin_manager::instance();

foreach ($pluginman->get_plugin_types() as $type => $dir) {
    $dir = substr($dir, strlen($CFG->dirroot));
    printf(
        "%-20s %-50s %s" . PHP_EOL,
        $type,
        $pluginman->plugintype_name_plural($type),
        $dir)
    ;
}

Plugin type deprecation

When a plugin or subplugin type is no longer needed or is replaced by another plugin type, it should be deprecated. Using components.json or subplugins.json plugin types and subplugin types, respectively, can be marked as deprecated.

The process for plugin and subplugin type deprecation differs slightly to the normal Deprecation process. Unlike with code deprecation, where the deprecated class or method is usually expected to remain functional during the deprecation window, deprecated plugin/subplugin types are treated as end-of-life as soon as they are deprecated.

Once deprecated, core will exclude plugins of the respective plugin type when performing common core-plugin communication, such as with hooks, callbacks, events, and-so-on. In the case of subplugins, the subplugin owner (the component which the subplugin belongs to), must have been updated to remove or replace all references to the subplugins before the time of deprecation.

Class autoloading and string resolution is still supported during the deprecation window, to assist with any plugin migration scripts that may be required.

:::info limitations

Whilst both plugin and subplugin types can be deprecated, only those plugin types which do not support subplugins can be deprecated.

:::

Deprecation process

Deprecation follows a 3 stage process:

1. The plugin/subplugin type is marked as deprecated (a core version bump is also required).
2. The plugin/subplugin type is marked as deleted (a core version bump is also required).
3. Final removal of the plugin/subplugin type from the respective config file.

First stage deprecation

During first stage deprecation, plugins of the respective type may remain installed, but are deemed end-of-life.

This stage gives administrators time to remove the affected plugins from the site, or migrate them to their replacement plugins.

Second stage deprecation

The second stage deprecation is the deletion phase.

If any affected plugins are still present (that is any which have not been uninstalled or migrated yet), the site upgrade will be blocked.

These plugins must be removed before continuing with site upgrade.

Final deprecation

In the final deprecation stage the relevant configuration changes supporting first and second stage deprecation can be removed from the respective config files. This removes the last reference to these plugin/subplugin types.

Deprecating a plugin type

The first phase of plugin type deprecation involves describing the plugin in the deprecatedplugintypes configuration in lib/components.json. The plugin type must also be removed from the plugintypes object.

The second phase of plugin type deprecation involves moving the entry from the deprecatedplugintypes object to the deletedplugintypes object.

:::info Remember

Don't forget to increment the core version number when marking a plugin/subplugin type for either deprecation or deletion. A version bump isn't needed for final removal.

:::

:::tip Example of plugin type deprecation config values

To mark a plugin type as deprecated in components.json, the plugin type should be removed from the plugintypes object, and added to a new deprecatedplugintypes object.

{
    "plugintypes": {
        ...
    },
    "subsystems": {
        ...
    },
    "deprecatedplugintypes": {
        "aiplacement": "ai/placement"
    }
}

To mark a plugin type as deleted in components.json, the plugin type should be removed from the deprecatedplugintypes object, and added to a new deletedplugintypes object. If the deprecatedplugintypes object is now empty, it may be removed entirely from config.

{
    "plugintypes": {
        ...
    },
    "subsystems": {
        ...
    },
    "deletedplugintypes": {
        "aiplacement": "ai/placement"
    }
}

Third stage deprecation just removes the plugin type from the deletedplugintypes object. If the deletedplugintypes object is now empty, it may be removed entirely from config.

{
    "plugintypes": {
        ...
    },
    "subsystems": {
        ...
    },
}

:::

Deprecating a subplugin type

To mark a subplugin type as deprecated, edit the component's subplugins.json file, remove the subplugin type from the subplugintypes object and add it to the deprecatedsubplugintypes object. The mark a subplugin type for stage 2 deprecation (deletion), edit the same file and move the subplugin type from the deprecatedsubplugintypes object to the deletedsubplugintypes object.

Following deletion, the plugin/subplugin type can be removed from the respective JSON entirely.

:::info Remember

Don't forget to increment the core version number when marking a plugin/subplugin type for either deprecation or deletion. A version bump isn't needed for final removal.

:::

:::tip Example of subplugin type deprecation config values

To mark a subplugin type as deprecated in a component's subplugins.json, the subplugin type should be removed from the subplugintypes object, and added to a new deprecatedsubplugintypes object.

{
    "subplugintypes": {
        "ltiservice": "service"
    },
    "deprecatedsubplugintypes": {
        "ltisource": "source"
    }
}

To mark a subplugin type as deleted in a component's subplugins.json, the subplugin type should be removed from the deprecatedsubplugintypes object, and added to a new deletedsubplugintypes object. If the deprecatedsubplugintypes object is now empty, it may be removed entirely from config.

{
    "subplugintypes": {
        "ltiservice": "service"
    },
    "deletedsubplugintypes": {
        "ltisource": "source"
    }
}

Third stage deprecation just removes the subplugin type from the deletedsubplugintypes object. If this object is then empty, it may be removed entirely from config.

{
    "subplugintypes": {
        "ltiservice": "service"
    }
}

:::

See also

• Guidelines for contributing code
• Core APIs
• Frankenstyle
• Moodle Plugins directory
• Tutorial to help you learn how to write plugins for Moodle from start to finish, while showing you how to navigate the most important developer documentation along the way.