Documentation Wiki

Basic file structure of a PostNuke module

A PostNuke module consists of number of files of various types (php code, templates, stylesheets etc.) placed into a directory in the modules directory. The layout of these files follows a fixed pattern.

• pnversion.php - a file containing the version information. This is read by the modules module.
• pntables.php - a file containing a description of the database tables handled by the module
• pninit.php - a file containing the code to install, upgrade and delete the module
• pnadmin.php or pnadmin/ - a file or directory containing the GUI functions for the module admin panel
• pnadminapi.php or pnadminapi/ - a file or directory containing the API functions for the module admin panel
• pnuser.php or pnuser/ - a file or directory containing the GUI functions for the user side of the module
• pnuserapi.php or pnuserapi/ - a file or directory containing the API functions for the user side of the module
• pnajax.php or pnajax/ - (.8 only) a file or directory containing functions that get called via ajax.php from a XMLHttprequest
• pnblocks/ - a directory containing any blocks provided by the module
• pnimages/ - a directory containing any images used by the module
• pnlang/ - a directory containing the language files for the module. Each language is stored in a subfolder (eng, fra, deu...)
• pntemplates/ - a directory containing the templates used to render the output from the module. Plugins are stored in the subfolder plugins/
• pnstyle - a directory containing any stylesheets used to display parts of the module output

A module may not contain all of these files or directories. This is dependent on the complexity of the module, the functionality it provides and the core features utilized.

---

CategoryDeveloperDocs