Activity modules

Activity modules reside in the 'mod' directory. Each module is in a separate subdirectory and consists of the following mandatory elements (plus extra scripts unique to each module):

• mod.html - a form to set up or update an instance of this module
• version.php - defines some meta-info and provides upgrading code
• icon.gif - a 16x16 icon for the module
• db/ - SQL dumps of all the required db tables and data (for each database type)
• index.php - a page to list all instances in a course
• view.php - a page to view a particular instance
• lib.php - any/all functions defined by the module should be in here. If the modulename is called widget, then the required functions include:

• widget_install() - will be called during the installation of the module
• widget_add_instance() - code to add a new instance of widget
• widget_update_instance() - code to update an existing instance
• widget_delete_instance() - code to delete an instance
• widget_user_outline() - given an instance, return a summary of a user's contribution
• widget_user_complete() - given an instance, print details of a user's contribution
• Other functions available but not required are:
  • widget_delete_course() - code to clean up anything that would be leftover after all instances are deleted
  • widget_process_options() - code to pre-process the form data from module settings
  • widget_reset_course_form() and widget_delete_userdata() - used to implement Reset course feature.
• To avoid possible conflict, any module functions should be named starting with widget_ and any constants you define should start with WIDGET_

• config.html - (optional) a form to set up or update global settings of this module
• Lastly, each module will have some language files that contain strings for that module.

IMPORTANT: When creating a new module, the new name of the module must not contain numbers or other special characters!

You should also make sure that your activity module provides appropriate support for groups and metacourses.

See also

• Tracker issue [https://tracker.moodle.org/browse/CONTRIB-52 CONTRIB-52 Improvements to make NEWMODULE really useful] - including download link for new module template supporting roles, formslib etc. (unfinished)
• http://download.moodle.org/plugins16/mod/NEWMODULE.zip - new module template for versions of Moodle prior to 1.7. Please follow the README instructions inside the zip.
• Using Moodle Activity modules forum
• Using Moodle A new resource type: where do I put the language strings? forum discussion
• Using Moodle New Module Template Code for Moodle 1.7 forum discussion