Plugins FAQ: Difference between revisions

From MoodleDocs
(added template)
m (Added see also * Tertiary education)
 
(13 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Extending standard Moodle}}
{{Installing Moodle}}==What is a plugin?==
{{Improve}}
==What is contributed code?==


Contributed code, or "contrib" for short, is understood to be all code contributed to Moodle which is not included in the standard Moodle distribution.
A plugin, (previously known as an add-on, contributed code, or "contrib" for short), is code enabling you to add additional features and functionality to Moodle.


==Where can I download contributed modules and plugins from?==
A number of plugins are included in the standard Moodle download. Additional plugins may be obtained from the [http://moodle.org/plugins Moodle plugins directory].
 
==How do I install a plugin?==
The [http://moodle.org/mod/data/view.php?id=6009 Modules and plugins database] is a comprehensive reference of all known Moodle modules, hacks and plugins.
See [[Installing plugins]] for instructions. Some, but not all, contributors include a "Read me" file with instructions in their plugin package.  
 
==How do I install a contributed module or plugin?==
 
See [[Installing contributed modules or plugins]] for instructions. Often the Module and plugin database will also have instructions for a specific contributed code.  Some, but not all, contributors include a "Read me" file with instructions in their contributed code package.


In a typical install, you will probably copy some php files into one or more areas of you Moodle site's code, then click on the Site administration link called "Notifications" to start the install process.
In a typical install, you will probably copy some php files into one or more areas of you Moodle site's code, then click on the Site administration link called "Notifications" to start the install process.
==How do I apply a patch?==
==How do I apply a patch?==
 
See [https://docs.moodle.org/dev/How%20to%20apply%20a%20patch dev:How to apply a patch].
See [[Development:How to apply a patch]].
==Why doesn't my newly installed plugin show up in the list of plugins?==
 
Firstly, check that you have visited your admin index page <nowiki>http://your_moodle_site.org/admin/index.php</nowiki> to complete the installation. Next, check that you unzipped the archive to the correct folder, and that the new plugin folder is not contained within another folder.
==Why doesn't my newly installed module show up in the list of modules?==
 
Firstly, check that you have visited your admin index page <nowiki>http://your_moodle_address/admin/index.php</nowiki> to complete the installation. Next, see the section on installation trouble-shooting in [[Installing contributed modules or plugins]] for further things to check.
 
==How do I contribute code to Moodle?==
==How do I contribute code to Moodle?==
 
See [https://moodledev.io/general/community/plugincontribution Guidelines for contributed code].
See our [[Development:Guidelines for contributed code|Guidelines for contributed code]].
==Is there any information on creating a new plugin?==
 
Yes! See [https://moodledev.io/docs/apis/plugintypes Plugin types].
==Is there any information on creating a new module or plugin?==
 
See [[Development:Modules]], [[Development:Blocks]] and [[Development:Authentication plugins]].
 
==How do I upgrade my contrib code to Moodle 2.0?==
 
See [[Development:Migrating contrib code to 2.0]].
 
==See also==
==See also==
 
* Using Moodle [http://moodle.org/mod/forum/view.php?id=44 General plugins forum]
* Using Moodle [http://moodle.org/mod/forum/view.php?id=44 Contributed modules and plugins forum]
* [https://moodle.org/mod/forum/discuss.php?d=325804#p1309721 Moodle 2015 favorite plugins] forum thread by Gavin Henrick, with lots of useful information about Moodle plugins
* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=138573 Converting custom modules to 2.0] forum discussion
* [[Tertiary education]] with many plugins useful for universities.
* [[Secondary education]] with many plugins useful for secondary education.


[[Category:Contributed code]]
[[Category:Contributed code]]
[[Category:FAQ]]
[[Category:FAQ]]
[[de:Plugins FAQ]]
[[es:Plugins FAQ]]
[[fr:FAQ de code tiers]]

Latest revision as of 18:31, 4 March 2024

What is a plugin?

A plugin, (previously known as an add-on, contributed code, or "contrib" for short), is code enabling you to add additional features and functionality to Moodle.

A number of plugins are included in the standard Moodle download. Additional plugins may be obtained from the Moodle plugins directory.

How do I install a plugin?

See Installing plugins for instructions. Some, but not all, contributors include a "Read me" file with instructions in their plugin package.

In a typical install, you will probably copy some php files into one or more areas of you Moodle site's code, then click on the Site administration link called "Notifications" to start the install process.

How do I apply a patch?

See dev:How to apply a patch.

Why doesn't my newly installed plugin show up in the list of plugins?

Firstly, check that you have visited your admin index page http://your_moodle_site.org/admin/index.php to complete the installation. Next, check that you unzipped the archive to the correct folder, and that the new plugin folder is not contained within another folder.

How do I contribute code to Moodle?

See Guidelines for contributed code.

Is there any information on creating a new plugin?

Yes! See Plugin types.

See also