Addon Module Developer Docs - Revision history

Matt: Replaced content with "This page has moved to https://developers.whmcs.com/addon-modules/"

2017-01-28T17:56:24Z

Replaced content with "This page has moved to https://developers.whmcs.com/addon-modules/"

Show changes

Matt: /* Client Area Output */

2016-08-02T15:26:50Z

‎Client Area Output

John: /* Multi-Language */

2016-04-21T06:47:29Z

‎Multi-Language

John: /* Getting Started */

2016-04-01T13:45:18Z

‎Getting Started

John: /* App Store */

2016-03-22T11:16:03Z

‎App Store

Cole at 20:46, 15 January 2016

2016-01-15T20:46:16Z

Andrew: DOCS-6346

2015-12-24T11:31:35Z

DOCS-6346

Show changes

John at 13:48, 14 April 2015

2015-04-14T13:48:35Z

John at 20:52, 27 March 2015

2015-03-27T20:52:31Z

John at 20:35, 27 March 2015

2015-03-27T20:35:47Z

@@ Line 173: / Line 173: @@
          'breadcrumb' => array('index.php?m=demo'=>'Demo Addon'),
          'templatefile' => 'clienthome',
-         'requirelogin' => true, # or false
+         'requirelogin' => true, # accepts true/false
          'vars' => array(
              'testvar' => 'demo',

@@ Line 195: / Line 195: @@
 If language files exist, WHMCS will then load these whenever the custom module is accessed. WHMCS will select the appropriate language file based on the current administrators language setting. If no matching language file exists within the module folder, it will fall back to the default language set in the module’s config array.
 The language variables are then passed into the _output and _sidebar functions array using “_lang”.
 Below is a demonstration of how you specify the default language for your module in the config array.

← Older revision		Revision as of 13:45, 1 April 2016
Line 22:		Line 22:

	Once you have chosen your name, you need to create a directory and module file for it. Addon modules are found in the /modules/addons/ directory. Each module can be found within it's own directory '''/your_module_name/'''. Then the core module file within it should be “your_module_name.php” to match the folder.		Once you have chosen your name, you need to create a directory and module file for it. Addon modules are found in the /modules/addons/ directory. Each module can be found within it's own directory '''/your_module_name/'''. Then the core module file within it should be “your_module_name.php” to match the folder.
−
−	An '''example module''' file which you can use as a basis for all custom addon modules is included with WHMCS. This can be found at the path '''/modules/addons/addonexample/''' within the WHMCS installation. Now let’s move onto customising the module…

	==Configuration==		==Configuration==

@@ Line 251: / Line 251: @@
 </source>
-==App Store==
+==WHMCS Marketplace==
-WHMCS offers an app store which accepts submission of the completed module. Displayed listings are found under the Addons tab within the administration area and online at http://www.whmcs.com/appstore . This is a great way to make WHMCS users aware of the module.
+WHMCS offers a Marketplace which accepts submission of the completed module. Displayed listed are found under the Addons tab within the administration area and online at http://marketplace.whmcs.com . This is a great way to make WHMCS users aware of the module.
-Submission of a listing requires a login for whmcs.com/members, if you do not have one please [https://www.whmcs.com/members/submitticket.php?step=2&deptid=5 Contact Us]. Once logged in, visit the app store page at the above URL and click the "Submit your Addon" link. We aim to review submissions in 1-2 weeks.
+For help using the Marketplace please refer to https://marketplace.whmcs.com/help . We aim to review submissions in 1-2 weeks.
 {{Developer_Links}}

@@ Line 1: / Line 1: @@
 Addon modules allow you to create both admin pages and hooks to extend WHMCS further.
-Addon Modules can consist of just an admin page, or just hooks, or both. They are all managed through the '''Setup > Addon Modules''' interface.
+Addon Modules can consist of just an admin page, just hooks, or both. They are all managed through the '''Setup > Addon Modules''' interface.
 {{Developer_Links}}
@@ Line 68: / Line 68: @@
 The deactivation function should undo everything that the activation function does to remove the module from the users system.
-There will already be an active database connection when the module is run. So, to access the WHMCS database you won’t need to reconnect to the database.
+There will already be an active database connection when the module is run, so to access the WHMCS database you won’t need to reconnect to the database.
 For example, the activate and deactivate functions could create and drop a table for use by the custom module as below:
@@ Line 112: / Line 112: @@
 ===Variables===
-The output function is passed all the fields defined in your modules config, along with the values users have set for them. As well as a “modulelink” variable which you can use to link back to the module.
+The output function is passing all the fields defined in your modules config, along with the values users have set for them, as well as a “modulelink” variable which you can use to link back to the module.
 ===Linking/Actions===
@@ Line 122: / Line 122: @@
 ===Admin User Data===
-To access the currently logged in admin ID should the module need that, in the session. Within the module, use $_SESSION[‘adminid’]. From that, the module can find any extra information you need in tbladmins.
+To access the currently logged in admin ID should the module need that, in the session, use $_SESSION[‘adminid’]. From that, the module can find any extra information you need in tbladmins.
 ===Example===
@@ Line 185: / Line 185: @@
+}
 </source>
 The above assumes a template, clienthome.tpl, existing within the module folder to use for the output.
@@ Line 202: / Line 192: @@
 Modules can support multiple languages should you wish.
-For this, the addon module needs a lang subfolder creating within it. Within that, language files can be created matching the names of the main WHMCS admin area language files. The admin language files are located in the /admin/lang/ folder.
+For this, the addon module needs a lang subfolder created within it. Within that, language files can be created matching the names of the main WHMCS admin area language files. The admin language files are located in the /admin/lang/ folder.
 WHMCS has the language variables for custom modules separate to make installation and updating easier.
-If language files exist, WHMCS will then load these whenever the custom module is accessed. WHMCS will select the appropriate language file based on the current administrators language setting. If no matching language file exists within th module folder, it will fall back to the default language set in the module’s config array.
+If language files exist, WHMCS will then load these whenever the custom module is accessed. WHMCS will select the appropriate language file based on the current administrators language setting. If no matching language file exists within the module folder, it will fall back to the default language set in the module’s config array.
 The language variables are then passed into the _output and _sidebar functions array using “_lang”.
@@ Line 227: / Line 217: @@
 ==Hooks==
-Hooks that the module should define within WHMCS are defined in a file named “hooks.php”. This should be within your custom module folder. That will then become detected and any hooks loaded on every page of WHMCS.
+Hooks that the module should define within WHMCS are defined in a file named “hooks.php”. This should be within your custom module folder. That will then become detected and any hooks that exist will be loaded on every page of WHMCS.
 The hook functions within that file should be defined in exactly the same way as normal.
@@ Line 235: / Line 225: @@
 ==Upgrades==
-Releasing updates and upgrades to custom modules is likely something done at some point. If those need to modify the database structure or perform other functions that would be handled in the _activate function, then you need some way of handling that.
+Releasing updates and upgrades to custom modules is likely something that is needed to be done at some point. If those modules need to modify the database structure or perform other functions that would be handled in the _activate function, then you need some way of handling that.
 With the Addon Modules system, this is a breeze with the upgrade function. The upgrade function is called the first time a module is accessed following an update. The update is detected by a change of version number in the _config array of the module. The upgrade function is passed the previous version number so that the module can then decide what updates to run within that function. This allows the module to bring it up to date with your latest version.

← Older revision		Revision as of 13:48, 14 April 2015
Line 10:		Line 10:
	Once activated, the modules will display in a dedicated "Addons" dropdown menu within the admin area for quick & easy access from any page.		Once activated, the modules will display in a dedicated "Addons" dropdown menu within the admin area for quick & easy access from any page.

−	Management options consist of activating and deactivating of the modules, ~~aswell~~ as access control which allows full admins to define exactly which of the administrator roles are allowed to access each addon module.	+	Management options consist of activating and deactivating of the modules, as well as access control which allows full admins to define exactly which of the administrator roles are allowed to access each addon module.

@@ Line 1: / Line 1: @@
 Addon modules allow you to create both admin pages and hooks to extend WHMCS further.
-Modules can consist of just an admin page, or just hooks, or both. And they are all managed through the '''Setup > Addon Modules''' interface.
+Addon Modules can consist of just an admin page, or just hooks, or both. And they are all managed through the '''Setup > Addon Modules''' interface.
 Once activated, the modules will display in a dedicated "Addons" dropdown menu within the admin area for quick & easy access from any page.
@@ Line 246: / Line 251: @@
+}
 </source>