Navigation

Views

Search
 

Toolbox

Module Requirements

From Documentation

Revision as of 16:09, 21 November 2006; view current revision
←Older revision | Newer revision→
  1. Each module must be contained in a single directory.
  2. Each module must have a config.php file that includes needed information.
  3. The users should be able to activate and use the module from the "Modules" menu in the administrative. Optimally, a module should not require users to modify the source code.
  4. If the module is going to interact with 68 Classifieds hook system it must contain a file mod_user.php and all functions must include the module name before the hook. For example: my_module_start() is a valid function name where start() is not. If you name your function incorrectly it will not cause problems except it will never be called through the script.
  5. If needed inside the modules directory it can have a templates, language, and plugins directory. The templates directory would contain any template files needed. The language directory allows your module to work for mutiple language. Please be careful not to name a language string the same as the standard language file. The plugins directory is to place any smarty plugins that you would like to use for this module.
  6. index.php and admin.php and used if the module has a frontend area or an administration section. These are only required if the user needs to have some of interaction with the module.
  7. You may include any other files that the module may need to enteract with.