Welcome to Elgg's documentation

This is the place to find documentation on all aspects of Elgg. If you would like to contribute your own documentation please do; we want this to be a real community effort!

Making a new plugin mini-HOWTO

From Elgg Documentation

1. Create a folder for your plugin inside the /mod folder. The name of this folder will be your plugin name. Example /mod/my_plugin

2. Create a lib.php folder inside the plugin folder.

3. Your library must contain a function called my_plugin_pagesetup. This function will be called by elgg as each page is loaded. Here is an empty function shell:

<?php
// Sample lib.php for a plugin

function my_plugin_pagesetup() {
    global $CFG; // You may want this to access global configuration values
    global $PAGE; // You may want this to modify the current page
 
    // your code goes here

}

?>


4. Optionally, your library can also contain a function called my_plugin_init. This function is called once when a user enters elgg, and can be used for global changes to the elgg environment.

5. Take a look at /mod/README.txt for more details.