plugins/pluginversions

Why install additional plugins? | ]
Choosing the best plugins for your site | ]
Plugins for school teaching | ]
Plugins for university teaching | ]
Considerations for production sites (skip if you're just moodling) | ]
Installing a plugin | ]
Installing plugins with Composer (Packagist) | ]
Before you start | ]
Install a plugin | ]
Update a plugin | ]
Remove a plugin | ]
Good practice for Composer-managed sites | ]
Notes | ]
Installing via uploaded ZIP file | ]
Installing manually at the server | ]
Troubleshooting | ]
Errors | ]
A file permissions error has occurred | ]
Default exception handler: Error writing to database Debug: Duplicate entry 'en_us-... | ]
When installing manually | ]
Obtaining help | ]
Uninstalling a plugin | ]
Plugins overview | ]
Plugin updating from within Moodle | ]
Preventing installing plugins from within Moodle | ]
See also | ]

1 Why install additional plugins?
2 Choosing the best plugins for your site
- 2.1 Plugins for school teaching
- 2.2 Plugins for university teaching
3 Considerations for production sites (skip if you're just moodling)
4 Installing a plugin
5 Troubleshooting
6 Uninstalling a plugin
7 Plugins overview
- 7.1 Plugin updating from within Moodle
8 Preventing installing plugins from within Moodle
9 See also

Why install additional plugins? | ]

Plugins enable you to add additional features and functionality to Moodle, such as new activities, new quiz question types, new reports, integrations with other systems and many more.

Note: Certain hosting solutions, such as MoodleCloud, prevent plugins being installed from within Moodle.

Choosing the best plugins for your site | ]

Install and test plugins in a non-production environment before using them on a production site.

When choosing a plugin in Moodle Marketplace:

check that it supports your Moodle version
review its description, documentation and installation requirements
check when it was last updated and whether it appears to be actively maintained
review its support information
check whether it requires an external service, license or additional payment
review any awards shown on the plugin page, such as the Privacy friendly or Mobile app award

Plugins for school teaching | ]

For the various school environments (ages 4 - 18 ) consider the following:

Plugins for university teaching | ]

For universities, there is a list of plugins by/for Universities, and a link to discipline-specific plugins, which might be worth considering.

Considerations for production sites (skip if you're just moodling) | ]

VERY IMPORTANT!

Some plugins in the directory have not been reviewed for quality or suitability for your Moodle site, so please use discretion when installing them because a plugin may not behave as expected, and in rare cases could introduce security issues. This is improving as the Moodle Marketplace evolves.

If you have a large site for production purposes consider if you really need the plugin? More functionality means more things to support, more things to (potentially) go wrong and more things to worry about at upgrade time.
Is the plugin supported and maintained? If something goes wrong can you get support? Will bugs be fixed?
If the plugin does not work in a future version of Moodle, what will you do about it?
Be cautious of any plugin whose installation instructions ask you to manually modify or replace core Moodle files. This isn't standard practice, and isn't guaranteed to survive a future Moodle upgrade, since it bypasses Moodle's normal plugin structure.
Look at this forum thread and also this forum thread since both discuss examples of users worried about installing a plugin.

Installing a plugin | ]

Installing plugins from admin interface

To install a plugin, its source code must be put (deployed) into the appropriate location inside the Moodle installation directory and the main administration page Site administration > Notifications must be visited. You can deploy a plugin by:

uploading a plugin ZIP file through the Moodle administration interface
installing a compatible plugin with Composer, if your Moodle site is Composer-managed
copying the plugin files to the server manually

To upload a ZIP file through the administration interface, the web server process must have write access to the relevant plugin-type directory.

Note: Whenever you install or download a plugin from the Moodle plugins directory, it is extremely important that you have correctly chosen your Moodle version. If you mistakenly download and install the wrong version of a plugin for your Moodle server, this may lead to some serious problems, even freezing of the Moodle site.

Installing plugins with Composer (Packagist) | ]

If your Moodle site is Composer-managed, you can install compatible plugins directly from Packagist.

Before you start | ]

Confirm your site is Composer-managed.
Confirm your project requires `moodle/composer-installer` in production dependencies.
Confirm the target plugin is available on Packagist and declares correct Moodle Composer metadata.

Install a plugin | ]

From your project root:

composerrequireabgreeve/moodle-block_stash

Then complete the Moodle upgrade process if prompted.

Update a plugin | ]

composerupdateabgreeve/moodle-block_stash

Remove a plugin | ]

composerremoveabgreeve/moodle-block_stash

After removal, complete the Moodle uninstall or upgrade flow as needed.

Good practice for Composer-managed sites | ]

Commit changes to `composer.json` and `composer.lock` together.
Test plugin changes in a non-production environment first.
Use one installation method per plugin to avoid drift.

Notes | ]

This method does not apply to non-Composer Moodle sites.
If a plugin is not in Packagist or is not Composer-compatible, use the standard installation methods described elsewhere on this page.

Installing via uploaded ZIP file | ]

Go to the Moodle Marketplace, Sign in, select your current Moodle version and download the appropriate plugin version as a ZIP file.
Login to your Moodle site as an admin and go to Site administration > Plugins > Install plugins. (a) There are two options you can choose when you get to this page. One of them is the "Install plugins from the Moodle plugins directory" button. This used to install a plugin directly; that direct-install flow ended with the launch of Moodle Marketplace, so the button now takes you to a temporary page with a link through to Moodle Marketplace instead. Click through, log in to Marketplace, find the plugin you want, and download the ZIP file. (b) The second option on this page (if you haven't clicked the above mentioned button) allows you to upload a previously downloaded zip file.

Upload the ZIP file. You should only be prompted to add extra details (in the Show more section) if the location where your plugin will install is not automatically detected.
If your target directory is not writeable, you will see a warning message.
Check the plugin validation report.

Installing manually at the server | ]

If you can't deploy the plugin code via the administration web interface, you have to copy it to the server file system manually (e.g. if the web server process does not have write access to the Moodle installation tree to do this for you).

First, establish the correct place in the Moodle code tree for the plugin type. Common locations are:

/path/to/moodle/theme/ - themes
/path/to/moodle/mod/ - activity modules and resources
/path/to/moodle/blocks/ - sidebar blocks
/path/to/moodle/question/type/ - question types
/path/to/moodle/question/behaviour/ - question behaviours
/path/to/moodle/course/format/ - course formats
/path/to/moodle/admin/report/ - admin reports

See dev:Plugin types for the full list of all plugin types and their locations within the Moodle tree.

Go to the Moodle plugins directory; select your current Moodle version, then choose a plugin with a Download button and download the ZIP file.
Upload or copy it to your Moodle server.
Unzip it in the right place for the plugin type (or follow the plugin instructions).
In your Moodle site (as admin) go to Site administration > Notifications (you should, for most plugin types, get a message saying the plugin is installed).

Note: The plugin may contain language files. They'll be found by your Moodle automatically. These language strings can be customized using the standard Site administration > Language editing interface. If you get a "Database error" when you try to edit your language files, there is a strong chance that the language files included within the downloaded ZIP file of this plugin have a coding problem. If you delete the plugin_name/lang/other_language_different_to_English/ folder with the new language strings and the database error disappears, this is indeed the case. Please notify the plugin maintainer, so that it can be fixed in future releases.

Troubleshooting | ]

Errors | ]

If you obtain an error, please turn debugging on to obtain additional information about the cause of the error.

Database error while doing a language customization: May not be related to the Language customization, but rather a problem with a recently installed plugin.

tool_installaddon/err_curl_exec - cURL error 60: This suggests problems with the validation of the SSL certificate of the remote (moodle.org) site. This is also a known problem in Moodle Windows 7 servers running the Moodle package for Windows. See SSL certificate for moodle.org for more info and possible solutions.

A file permissions error has occurred | ]

On certain 3.0.x versions, when installing plugins via the administration interface, Moodle uses the configuration settings $CFG->directorypermissions and $CFG->filepermissions. If these are not defined explicitly in your config.php, the default value is set automatically to 777 (rwxrwxrwx) for directories and 666 (rw-rw-rw-) for files (see lib/setup.php).

If this default behaviour does not fit your needs and hosting environment, you may wish to specify more strict setting such as

$CFG->directorypermissions = 02750;

A common error after installing plugins is that when you create an instance of the module and then save and display it, it reports the error, "A file permissions error has occurred. Please check the permissions on the script and the directory it is in and try again." If you get this, the file permissions of the package are most likely set to 711 preventing them from running correctly. With your preferred FTP client or via your web hosts control panel, set the file permissions of all the files and directories in the installed module, e.g. /moodle/mod/[myplugin]/ to 755 and then see if you can successfully view the module instance.

Default exception handler: Error writing to database Debug: Duplicate entry 'en_us-... | ]

These errors are usually caused by a third party plugin.
To find the involved plugin, go to http://lang.moodle.org and use the AMOS tool to find all the strings with the given string identifier.
Remove the suspected plugin and check if the error has disappeared. If so, please contact the plugin maintainer and report this issue.
Please see this forum thread for known causes and fixes.

When installing manually | ]

Check the file permissions. The web server needs to be able to read the plugin files. If the rest of Moodle works then try to make the plugin permissions and ownership match.
Did you definitely unzip or install the plugin in the correct place?
Because Moodle scans plugin folders for new plugins you cannot have any other files or folders there. Make sure you delete the zip file and don't try to rename (for example) an old version of the plugin to some other name - it will break.
Make sure the directory name for the plugin is correct. All the names have to match. If you change the name, then it won't work.

Obtaining help | ]

Ask in a forum in Moodle in English. Make sure you describe your system (including versions of MySQL, PHP etc.), what you tried and what happened. Copy and paste error messages exactly. Provide the link to the version of the plugin you downloaded (some have very similar names).

Uninstalling a plugin | ]

To uninstall a plugin

Go to Site Administration > Plugins > Plugins overview and click the Uninstall link opposite the plugin you wish to remove
Use a file manager to remove/delete the actual plugin directory as instructed, otherwise Moodle will reinstall it next time you access the site administration

Plugins overview | ]

The Plugins overview page in Site Administration > Plugins > Plugins overview lists all installed plugins, together with the version number,release, availability (enabled or disabled) and settings link (if applicable).

A 'Check for available updates' button enables admins to quickly check for any updates available for plugins installed on the site (from Moodle Marketplace). Any updates available are highlighted, with further information and a download link in the notes column opposite the plugin.

Plugin updating from within Moodle | ]

An administrator can enable updates deployment in Site Administration > Server > Update notifications. Then when updates are available, 'Install this update' buttons are shown on the Plugins overview page. See Automatic updates deployment for more details.

Preventing installing plugins from within Moodle | ]

If required, installing and updating from within Moodle can be prevented by copying the following lines of code from config-dist.php and pasting them in config.php.

// Use the following flag to completely disable the installation of plugins
// (new plugins, available updates and missing dependencies) and related
// features (such as cancelling the plugin installation or upgrade) via the
// server administration web interface.
$CFG->disableupdateautodeploy = true;