Module File Headers

Each module in SudoWorkspace consists of an init file which contains the general module configuration and includes headers containing meta-information regarding the module.

Module init file headers example

The following example is taken from the default SudoWorkspace module Menu Setup that comes with the installation.

<?php
defined('BASEPATH') or exit('No direct script access allowed');
/*
Module Name: Menu Setup
Description: Default module to apply changes to the menus
Version: 2.3.0
Requires at least: 2.3.*
*/

<?php
defined('BASEPATH') or exit('No direct script access allowed');
/*
Module Name: Menu Setup
Description: Default module to apply changes to the menus
Version: 2.3.0
Requires at least: 2.3.*
*/

<?php
defined('BASEPATH') or exit('No direct script access allowed');
/*
Module Name: Menu Setup
Description: Default module to apply changes to the menus
Version: 2.3.0
Requires at least: 2.3.*
*/

Available Headers

You can find below the list of available headers that can be added to the module init file.

• Module Name – required
• Module URI – module URL
• Version – the version of the module
• Description – the description of the module, you can explain what the module does.
• Author – module author name
• Author URI – module author URL
• Requires at least – what version of SudoWorkspace does the module require at least