Search Knowledge Base Articles

Module File Headers

 Modules BuildX


Each module in Perfex CRM consist of init file which contains the general module configuration and includes headers containing meta-information regarding the module.

Module init file headers example 

The follow example is taken from the default Perfex CRM 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.* */

Available Headers

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

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

Did you find this article useful?

Related Articles

  • Introduction to Perfex CRM modules

    Modules BuildX The modules documentation is valid starting from version 2.3.2 Perfex CRM&...

  • Module Basics

     Modules BuildX The modules documentation is valid starting from version 2.3.2 Perfe...

  • Create Menu Items

    Modules BuildX If you are creating your custom modules, probably you will want to create menu ...

  • Common Module Functions

    Modules BuildX register_activation_hook /** * Register module activation hook * @param string $m...

  • Module Security

     Modules BuildX So, you created your module and works fine, but is it secure? You must en...