blog documentation FAQ forum marketplace youtube

Module Naming

The Jamroom Network » Documentation » Developer Guide » Module Naming
Applies to: Jamroom 7.0+ Last verified: 2026-10-24

Table of Contents:


The prefix
The names inside the module

  • The prefix

    Every module and skin directory starts with a prefix that identifies its developer, followed by the name in StudlyCaps: jrAudio, xxSignupNotify.

    • jr is The Jamroom Network's prefix. Don't use it.
    • xx is for modules you build for your own site. Developer Tools can package them, so you can move them between your sites.
    • For modules you'll release, choose a prefix of your own that nobody else uses, and keep it for all your modules and skins.

    The prefix is set in Developer Tools > Global Config > Developer Prefix. Packaging checks that the module's directory starts with it. See Packaging a Module.

  • The names inside the module

    The directory name is used everywhere, so functions can't clash between modules:

    What Name
    Functions xxFoo_something()
    Views view_xxFoo_(view)()
    Listeners xxFoo_(event)_listener(), by convention
    Template functions smarty_function_xxFoo_(name)()
    DataStore keys the prefix chosen in schema.php, such as foo_title

Tags