{"id":4087,"date":"2019-03-24T18:24:28","date_gmt":"2019-03-24T18:24:28","guid":{"rendered":"https:\/\/help.perfexcrm.com\/?p=4087"},"modified":"2025-10-16T11:11:50","modified_gmt":"2025-10-16T11:11:50","slug":"module-basics","status":"publish","type":"post","link":"https:\/\/help.perfexcrm.com\/module-basics\/","title":{"rendered":"Module Basics"},"content":{"rendered":"\n
The modules documentation is valid starting from version 2.3.2<\/b><\/div>\n\n\n\n

Perfex CRM modules use the Codeigniter PHP framework code base like controllers, models, language files, libraries, views etc… if you are already familiar with the Codeigniter framework, you will be able to easily get started, if not we recommend you to visit their official website <\/a>and documentation<\/a>.<\/p>\n\n\n\n

Additionally, we added a bunch of helper functions, features, action hooks and filters that will make the process of creating and integrating modules easier.<\/p>\n\n\n\n

Modules location & Name<\/h3>\n\n\n\n

All modules should be added in the modules <\/strong>folder in your root directory where Perfex CRM is installed and each module must have a unique folder name and init file with the same name as your module folder name<\/strong>.<\/p>\n\n\n\n

Creating your first module<\/h3>\n\n\n\n
Before start to develop a module, make sure that you set development mode<\/a> in order to see any errors and functions\/hooks deprecation warnings.<\/div>\n\n\n\n

To get started and create your first module, follow the steps below.<\/p>\n\n\n\n

    \n
  • Navigate to Perfex CRM installation and open the modules <\/strong>directory<\/li>\n\n\n\n
  • Create a new directory and name it after your module (e.q. sample_module<\/strong>)<\/li>\n\n\n\n
  • Create a new PHP file with the same name as the module directory<\/strong>, in this case, sample_module.php,\u00a0<\/strong>this\u00a0file\u00a0will\u00a0act\u00a0as\u00a0“init file”<\/strong>\u00a0for\u00a0this\u00a0module.<\/li>\n<\/ul>\n\n\n\n

    In this case, the module is already created and registered but it does not do anything yet nor have any name or descriptions added, we will add the module metadata like name, description, URL, author via a PHP block comment which will act as module headers.<\/p>\n\n\n\n

    The module headers should be added only in the init module file.<\/p>\n\n\n\n

    Now open the sample_module.php file we created before and add the following comment at the top of the file:<\/p>\n\n\n\n