Can I have underscore in my plugin folder name to be published on Moodle plugins directory?

Re: Can I have underscore in my plugin folder name to be published on Moodle plugins directory?

by Michael Milette -
Number of replies: 0
ምስሊ ናይ Core developers ምስሊ ናይ Documentation writers ምስሊ ናይ Particularly helpful Moodlers ምስሊ ናይ Plugin developers ምስሊ ናይ Testers ምስሊ ናይ Translators
Hi Lawrence,

I recommend that your git repository be named following this format:

moodle-plugintype_pluginname

Example:

moodle-filter_filtercodes

Your when installed in Moodle, the plugin's directory should be simply:

pluginname

... because the plugin type is already shown in its parent directory. Example:

/filter/filtercodes/

In this example, "filter" is the type and "filtercodes" is the plugin name.

All directory and file names should be completely in lowercase. No UPPERCASE, no camelCase.

The plugin name may have an underscore in it as seen with the Configurable Reports plugin: block_configurable_reports

It does work. However, like Davo said, I too have encountered some situations in the past where this has caused a problem. Therefore, I try avoid situations that will potential cause issues whenever possible.

Plugin directory names must never have an extension. Moodle will ignore them if they do. For example, Moodle would never detect the following:

/filter/filter.codes/

Hope you find this information helpful

Best regards,

Michael Milette
Average of ratings: Useful (1)