index.mdx

title	tags
Common files	Plugins API Subsystem

import { AmdDir, BackupDir, CLIDir, Changes, ClassesDir, DbAccessPHP, DbEventsPHP, DbInstallPHP, DbInstallXML, DbMessagesPHP, DbRenamedclassesPHP, DbServicesPHP, DbTasksPHP, DbUninstallPHP, DbUpgradePHP, EnvironmentXML, Lang, Lib, LocalLib, PixDir, Readme, ReadmeMoodleTXT, SettingsPHP, StylesCSS, ThirdpartylibsXML, UpgradeTXT, VersionPHP, YUIDir, } from '../_files';

This page describes the common files which may be present in any Moodle subsystem or plugin type. Some of these files are mandatory and must exist within a component, whilst others are optional.

version.php

lang/en/plugintype_pluginname.php

import extraLangDescription from '../_files/lang-extra.md';

lib.php

locallib.php

db/install.xml

db/upgrade.php

db/access.php

db/install.php

db/uninstall.php

db/events.php

db/messages.php

db/services.php

db/tasks.php

db/renamedclasses.php

classes/

cli/

settings.php

amd/

yui/

backup/

styles.css

pix/icon.svg

thirdpartylibs.xml

readme_moodle.txt

upgrade.txt

environment.xml

README

CHANGES

See also

• Moodle architecture - general overview of Moodle code architecture
• Plugin types - list of all supported plugin types
• Moodle plugins directory - repository of contributed plugins for Moodle
• Moodle plugin skeleton generator - allows to quickly generate code skeleton for a new plugin
• Checklist for plugin contributors - read before submitting a plugin