https://docs.moodle.org/35/en/api.php?action=feedcontributions&feedformat=atom&user=Koning 2026-04-22T22:47:13Z User contributions MediaWiki 1.43.5 https://docs.moodle.org/35/en/index.php?title=Development:Modules&diff=61034 2009-08-06T17:19:59Z

<p>Koning: /* Activity modules */</p> <hr /> <div>=== Activity modules === <br /> <br /> 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):<br /> <br /> * ''mod_form.php'' - a form to set up or update an instance of this module<br /> * ''version.php'' - defines some meta-info<br /> * ''icon.gif'' - a 16x16 icon for the module<br /> * ''db/install.xml'' - defines the structure of db tables for all database types. Is used during module installation<br /> * ''db/upgrade.php'' - defines changes in the structure of db tables. Is used during module upgrade<br /> * ''db/access.php'' - defines module capabilities<br /> * ''index.php'' - a page to list all instances in a course<br /> * ''view.php'' - a page to view a particular instance<br /> * ''lib.php'' - any/all functions defined by the module should be in here. If the module name is called '''widget''', then the required functions include:<br /> :* widget_install() - will be called during the installation of the module<br /> :* widget_add_instance() - code to add a new instance of widget<br /> :* widget_update_instance() - code to update an existing instance<br /> :* widget_delete_instance() - code to delete an instance<br /> :* widget_user_outline() - given an instance, return a summary of a user's contribution<br /> :* widget_user_complete() - given an instance, print details of a user's contribution<br /> :* widget_get_view_actions() / widget_get_view_actions() - Used by the participation report (course/report/participation/index.php) to classify actions in the logs table.<br /> :* Other functions available but not required are:<br /> :** widget_delete_course() - code to clean up anything that would be leftover after all instances are deleted<br /> :** widget_process_options() - code to pre-process the form data from module settings<br /> :** [[Development:Implementing Reset course functionality in a module|widget_reset_course_form() and widget_delete_userdata()]] - used to implement [[Reset course]] feature.<br /> :* To avoid possible conflict, any module functions should be named starting with widget_ and any constants you define should start with WIDGET_<br /> * ''backuplib.php'' and ''restorelib.php'' (optional)<br /> * ''settings.php'' or ''settingstree.php'' - (optional) a definition of an admin settings page for this module. mod/assignment/settings.php is a good simple example. mod/quiz/settingstree.php is a more complex example.<br /> * ''defaults.php'' - lets you easily define default values for your configuration variables. It is included by upgrade_activity_modules in lib/adminlib.php. It should define an array $defaults. These values are then loaded into the config table. Alternatively, if you set $defaults['_use_config_plugins'] to true, the values are instead loaded into the config_plugins table, which is better practice. See mod/quiz/defaults.php for an example. (This apparently only works with moodle 2.x branch.)<br /> * ''lang/en_utf8/widget.php'' - (optional) Lastly, each module will have some language files that contain strings for that module.<br /> <br /> === IMPORTANT: ===<br /> * When creating a new module, the new name of the module must not contain numbers or other special characters!<br /> <br /> * You need a ''data base table'' with the same name as your module. This table must have at least three fields: <br /> *# id <br /> *# course <br /> *# name<br /> <br /> * You should also make sure that your activity module provides appropriate support for groups and meta-courses. <br /> <br /> == See also ==<br /> <br /> * [[Development:Blocks]]<br /> * [[Development:Backup]]<br /> * Tracker issue [http://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) <br /> * 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.<br /> * [[Development:NEWMODULE_Documentation]]<br /> <br /> Using Moodle forum discussions:<br /> *[http://moodle.org/mod/forum/discuss.php?d=66165 A new resource type: where do I put the language strings?]<br /> *[http://moodle.org/mod/forum/discuss.php?d=65986 New Module Template Code for Moodle 1.7]<br /> *[http://moodle.org/mod/forum/discuss.php?d=90154 LEGACY roles and capabilities]<br /> <br /> [[Category:Developer|Modules]]<br /> [[Category:Modules]]<br /> [[Category:Tutorial]]<br /> <br /> [[es:Módulos de actividades (desarrollador)]]<br /> [[fr:Modules (développeur)]]<br /> [[ja:モジュール (開発者)]]<br /> [[zh:开发:模块_(开发者)]]<br /> [[de:Entwickler:Module]]</div>

Koning