|
register_module reference |
|
register_module.php contains properties that tell Thyme about the module. For more information, see the Module Overview and Hello World sections.
- display_name - Text value. The name or title of the module as displayed to a user
- priority - Integer value. The priority of a module dictates it's placement. This can affect it's order in relation to other modules. For instance, it's placement among other tabs or other links at Thyme's footer.
- parents - array containing the parents of this module. This dictates where the module will appear. Possible values are:
- footer - Thyme's footer
- tab - Thymes tabs
- navbar - Thyme's navigation bar
- admin - Thyme's admin panel
- admin_module - True/False value. Module only appears to Super Users
- no_guest - True/False value. Module only appears to users whom are logged in
- guest_only - True/False value. Module only appears to visitors whom are not logged in
- hide_nav - True/False value. Hide Thyme's navigation bar when this module is active.
- include - Text value. The file to include when this module is active. This is a path relative to the modules directory.
- navbar - Text value. Navigation bar modules only. This is the file included in the navigation bar when this module is active. The path should be relative to the modules directory.
- icon - Text value. Admin panel modules only. This is the file name of the icon displayed for this module in the admin panel. The icon must be located in the module's directory. E.g. default_options.gif
- configure - Text value. Navigation bar modules only. This is the file included in the navigation bar configuration module for configuration. The path should be relative to the modules directory. E.g. hello_world/config.php
|
