Module development - Revision history

Eldy at 17:14, 5 April 2026

2026-04-05T17:14:49Z

← Older revision		Revision as of 17:14, 5 April 2026
Line 19:		Line 19:
	*Add or remove tabs on object view (invoice, product, order, event, ...).		*Add or remove tabs on object view (invoice, product, order, event, ...).
	*Add predefined exports for the internal export tool.		*Add predefined exports for the internal export tool.
			*Add more CSS or JS code on all or some pages
	*Add new information widget in the home page.		*Add new information widget in the home page.
	*Add new substitutions variables.		*Add new substitutions variables.

TanguyP: Improve troubleshooting for SQL scripts (based on my personal experience)

2025-04-18T17:48:39Z

Improve troubleshooting for SQL scripts (based on my personal experience)

← Older revision		Revision as of 17:48, 18 April 2025
Line 105:		Line 105:
	===Test your .sql files===		===Test your .sql files===

	Once the files ready, you can return to the page to enable Dolibarr modules and disable the module, drop those tables in the database (if they already exist) and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check your scripts ~~by passing them by hand, or check~~ the Dolibarr logs.		Once the files ready, you can return to the page to enable Dolibarr modules and disable the module, drop those tables in the database (if they already exist) and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check the Dolibarr logs, or as a first step try running your scripts manually on your database (because SQL errors from your scripts may not show up in the Dolibarr logs).

	===Generate the PHP DAO class===		===Generate the PHP DAO class===

TanguyP: Improve wording; Fix links

2025-04-17T18:20:27Z

Improve wording; Fix links

← Older revision		Revision as of 18:20, 17 April 2025
Line 58:		Line 58:

	*Replace all occurrences of "modMyModule" with a value which corresponds to the purpose of your module. This value must always start with 'mod' and contain only alpha characters (again, if the name given to the file was 'NewName', then replace all "modMyModule" with "modNewName").		*Replace all occurrences of "modMyModule" with a value which corresponds to the purpose of your module. This value must always start with 'mod' and contain only alpha characters (again, if the name given to the file was 'NewName', then replace all "modMyModule" with "modNewName").
	*Change the number in: $this->numero = 100000 by a number that designates your module id. To avoid conflicts with other modules, you can consult the page that lists already reserved id numbers: [[List of modules id\|List of ~~modules id~~]].		*Change the number in: $this->numero = 100000 by a number that designates your module id. To avoid conflicts with other modules, you can consult the page that lists already reserved id numbers: [[List of modules id\|List of module IDs]].
	*Modify any other variables defined in the constructor (see comment in the code skeleton for their meaning).		*Modify any other variables defined in the constructor (see comment in the code skeleton for their meaning).

Line 198:		Line 198:
	</syntaxhighlight>		</syntaxhighlight>

	'''4. show tabs ~~into~~ your page'''		'''4. show tabs on your page'''

	Use ~~function~~ dol_fiche_head() to show all tabs defined ~~into array~~ $head returned by XX_prepare_head().		Use the <code>dol_fiche_head()</code> function to show all tabs defined in the <code>$head</code> array returned by <code>XX_prepare_head()</code>.

	<syntaxhighlight lang="PHP">		<syntaxhighlight lang="PHP">
Line 272:		Line 272:
	You may want to provide a module that adds more fields into forms (input and view) of some elements.		You may want to provide a module that adds more fields into forms (input and view) of some elements.

	A heavy solution (but not so bad) may be to replace all pages used to create element (this means ~~to disable~~ the "New element" menu entry and adding yours, and ~~disable~~ tab that shows element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in the menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerful since you can change everything you want into the page).		A heavy solution (but not so bad) may be to replace all pages used to create element (this means disabling the "New element" menu entry and adding yours, and disabling the tab that shows the element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in the menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerful since you can change everything you want into the page).

	We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...		We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...

	*First thing is to add a table, owned by your module, to store the value of new fields. This table will have ~~only~~ one column called "rowid" (will contain the same value ~~than field~~ rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For ~~this~~ two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].		*First thing is to add a table, owned by your module, to store the value of new fields. This table will only have one column called <code>rowid</code> (will contain the same value as the <code>rowid</code> column in the element table) + one column for each new field you want to add. Then, create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For those two tasks, go back to the previous chapter [[#Create your SQL tables and the PHP DAO class (optional)]].
	*Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.		*Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.

Line 381:		Line 381:
	Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.		Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

	==Define your entries in menu (optional)==		==Define your entries in the menu (optional)==
	'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.		'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

Line 501:		Line 501:

	==Define your CSS styles (optional)==		==Define your CSS styles (optional)==
	'''When''': If in your PHP pages, you use class styles that are not defined inside Dolibarr themes CSS (not ~~recommanded~~).		'''When''': If in your PHP pages, you use class styles that are not defined inside Dolibarr themes CSS (not recommended).

	===Create and declare your style sheet===		===Create and declare your style sheet===
Line 508:		Line 508:

	Once your style sheets are ready, declare them into your module descriptor file by modifying the property '''$this->modules_parts'''.		Once your style sheets are ready, declare them into your module descriptor file by modifying the property '''$this->modules_parts'''.
	Value to put here must be an array of relative URLs to your CSS files.		Value to put here must be an array of relative URLs of your CSS files.
	For example		For example
	<syntaxhighlight lang="PHP">		<syntaxhighlight lang="PHP">
Line 519:		Line 519:
	Go on the home page (index.php). Show the HTML source of the page.		Go on the home page (index.php). Show the HTML source of the page.

	~~You should see into~~ the HTML header, a line that declares your style sheet.		In the HTML header, you should see a line that declares your style sheet.

	==Add your ~~Javascript~~ functions (optional)==		==Add your JavaScript functions (optional)==
	'''When''': If in your PHP pages, you use javascript functions not available in Dolibarr (in file lib_head.js)		'''When''': If in your PHP pages, you use javascript functions not available in Dolibarr (in file lib_head.js)

	If you need to use your own ~~javascript~~ functions inside your PHP pages, it is necessary to ~~have~~ your functions~~, defined into~~ your ~~javascript~~ file '''htdocs/mymodule/js/mymodule.js''', included ~~into~~ the HTML ~~HEAD~~ section.		If you need to use your own JavaScript functions inside your PHP pages, it is necessary to define your functions in your JavaScript file '''htdocs/mymodule/js/mymodule.js''', included in the HTML <code><head/></code> section.
	~~To ask~~ Dolibarr that ~~forge this header~~ to include your ~~own javascript~~ file, you ~~must~~ just provide it to the llxHeader() function called by your page.		Dolibarr is responsible for building that HTML section. In order to ask it to include your JavaScript file, you just need to provide it to the llxHeader() function called by your page.

	Example for page /htdocs/mymodule/mypage.php :		Example for page /htdocs/mymodule/mypage.php :
Line 534:		Line 534:

	==Run your own code on any Dolibarr event (optional)==		==Run your own code on any Dolibarr event (optional)==
	'''When''': If you want to execute your own code once a common Dolibarr event has occurred (example: I want to update a table in my module when an invoice is created into Dolibarr), you must create a '''~~triggers~~'''.		'''When''': If you want to execute your own code once a common Dolibarr event has occurred (example: I want to update a table in my module when an invoice is created into Dolibarr), you must create a '''trigger'''.

	See also [[Interfaces_Dolibarr_toward_foreign_systems]]		See also [[Interfaces_Dolibarr_toward_foreign_systems]]
Line 551:		Line 551:

	==Add your document template (optional)==		==Add your document template (optional)==
	'''When''': When you want to ~~personalized~~ your own generated PDF or ODT documents.		'''When''': When you want to personalize your own generated PDF or ODT documents.

	Note: To add this feature you don't need to create a module descriptor.		Note: To add this feature, you don't need to create a module descriptor.

	Documentation to add your own template is available on page [[Create_a_PDF_document_template]] or [[Create_an_ODT_document_template]].		Documentation to add your own template is available on page [[Create_a_PDF_document_template]] or [[Create_an_ODT_document_template]].
Line 560:		Line 560:
	'''When''': When you want to personalized your colors/fonts/images.		'''When''': When you want to personalized your colors/fonts/images.

	Note: To add this feature you don't need to create a module descriptor.		Note: To add this feature, you don't need to create a module descriptor.

	To add your own skin, read page [[Skins]].		To add your own skin, read page [[Skins]].
Line 590:		Line 590:
	</syntaxhighlight>		</syntaxhighlight>

	*If you want your module to be public, you can submit it (the zip file) on Dolibarr marketplace website: {{LinkToPluginDownload}} (you must create an account ~~first~~ and be logged to use the ~~link~~ "Submit a module/product").		*If you want your module to be public, you can submit it (the zip file) on the Dolibarr marketplace website: {{LinkToPluginDownload}} (you must first create an account and be logged in to use the "Submit a module/product" link).
	**If your module was built correctly, the file will be validated later.		**If your module was built correctly, the file will be validated later.
	**If quality is ~~enough~~ and license permits it, the code might be added inside main Dolibarr sources (except if you disagree for that).		**If quality is sufficient and license permits it, the code might be added inside main Dolibarr sources (except if you disagree for that).

	=Enabling/activation condition of external module on DoliStore=		=Enabling/activation condition of external module on DoliStore=

TanguyP: Fix some language mistakes, improve some style

2025-04-16T19:33:42Z

Fix some language mistakes, improve some style

← Older revision		Revision as of 19:33, 16 April 2025
Line 12:		Line 12:
	{{TemplateDocDevEn}}		{{TemplateDocDevEn}}

	To create a new module/addon for Dolibarr, there is several steps. This tutorial will describe ~~you~~ each of them to build a module ~~to extend~~ Dolibarr features, ~~like one or several of the following~~ :		To create a new module/addon for Dolibarr, there are several steps. This tutorial will describe each of them to let you build a module that extends Dolibarr features, such as:

	*Add new tables in database.		*Add new tables in database.
Line 30:		Line 30:
	etc...		etc...

	~~Following~~ chapters ~~presents~~ how to do all of this manually ~~with~~ an easy way.		The following chapters explain how to do all of this manually in an easy way.

	=Module creation with the module builder=		=Module creation with the module builder=
	From Dolibarr v. 12.0 it is possible to create the main pages of your module with the Module Builder. To activate it:		From Dolibarr v. 12.0 it is possible to create the main pages of your module with the Module Builder. To activate it:

	Go into the list of ~~module~~ and enable the ~~module~~ "Module Builder"[[File:Module Builder.png\|alt=Module Builder\|thumb\|none]]		Go into the list of modules and enable the "Module Builder" module:
			[[File:Module Builder.png\|alt=Module Builder\|thumb\|none]]


Line 41:		Line 42:
	<br />		<br />
	=Template of an External Module=		=Template of an External Module=
	A good model to start development of external module can be found here : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module ~~Modèle~~]		A good model to start development of external module can be found here : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Template]

	=Create your module=		=Create your module=
Line 52:		Line 53:
	The first step is to create a file descriptor for the module.		The first step is to create a file descriptor for the module.

	*Create directory '''/htdocs/custom/''mymodule''/core/modules''' (for an external module) or '''/htdocs/''mymodule''/core/modules''' if you plan to have this module an official core module of Dolibarr. Then copy the file modMyModule.class.php from the directory '''htdocs/modulebuilder/template''' into this directory. Change the name of the file modMyModule.class.php to the name corresponding to the purpose of your module. Name of the file must start with ~~initial '~~mod' and end with .class.php (for example if you want to give the name 'NewName' to this file, then the name should be 'modNewName.class.php').		*Create directory '''/htdocs/custom/''mymodule''/core/modules''' (for an external module) or '''/htdocs/''mymodule''/core/modules''' if you plan to have this module an official core module of Dolibarr. Then copy the file <code>modMyModule.class.php</code> from the directory '''htdocs/modulebuilder/template''' into this directory. Change the name of the file <code>modMyModule.class.php</code> to the name corresponding to the purpose of your module. Name of the file must start with <code>mod</code> and end with <code>.class.php</code> (for example if you want to give the name 'NewName' to this file, then the name should be <code>modNewName.class.php</code>).

	~~Next~~ modify the contents of this file as follows:		Then, modify the contents of this file as follows:

	*Replace all "modMyModule" with a value which corresponds to the purpose of your module. This value must always start with 'mod' and contain only alpha characters (again, if the name given to the file was 'NewName', then replace all "modMyModule" with "modNewName").		*Replace all occurrences of "modMyModule" with a value which corresponds to the purpose of your module. This value must always start with 'mod' and contain only alpha characters (again, if the name given to the file was 'NewName', then replace all "modMyModule" with "modNewName").
	*Change the number in: $this->numero = 100000 by a number that designates your module id. To avoid conflicts with other modules, you can consult the page that lists already reserved id numbers: [[List of modules id\|List of modules id]].		*Change the number in: $this->numero = 100000 by a number that designates your module id. To avoid conflicts with other modules, you can consult the page that lists already reserved id numbers: [[List of modules id\|List of modules id]].
	*Modify any other variables defined in the constructor (see comment in the code skeleton for their meaning).		*Modify any other variables defined in the constructor (see comment in the code skeleton for their meaning).
Line 100:		Line 101:
	</syntaxhighlight>		</syntaxhighlight>

	Files must be operational for the database mysql. ~~Rem~~: The files of other databases are not maintained. They will be read and converted on the fly by the driver of the other database.		Files must be operational for the database mysql. Note: The files of other databases are not maintained. They will be read and converted on the fly by the driver of the other database.

	===Test your .sql files===		===Test your .sql files===

	Once the files ready, you can return to the page to enable Dolibarr modules and disable the module, drop those tables in the database (if they already ~~exists~~) and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check your scripts by passing them by hand, or check the Dolibarr logs.		Once the files ready, you can return to the page to enable Dolibarr modules and disable the module, drop those tables in the database (if they already exist) and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check your scripts by passing them by hand, or check the Dolibarr logs.

	===Generate the PHP DAO class===		===Generate the PHP DAO class===

Eldy: /* Create a Module descriptor for your Module (required) */

2025-03-29T12:37:20Z

Create a Module descriptor for your Module (required)

← Older revision		Revision as of 12:37, 29 March 2025
Line 45:		Line 45:
	=Create your module=		=Create your module=
	==Create a Module descriptor for your Module (required)==		==Create a Module descriptor for your Module (required)==
	'''When it is required''': Required as soon as an addon is developed, whatever its goal is (~~except for~~ adding a skin).		'''When it is required''': Required as soon as an addon is developed, whatever its goal is (only adding a skin does not require a module descriptor file).

	'''Since Dolibarr 9.0, you should use the ModuleBuilder module provided as a standard module to generate the module descriptor'''		'''Since Dolibarr 9.0, you should use the ModuleBuilder module provided as a standard module to generate the module descriptor'''

Sonikf: /* Module creation with the module builder */

2025-01-23T23:01:03Z

Module creation with the module builder

← Older revision		Revision as of 23:01, 23 January 2025
Line 35:		Line 35:
	From Dolibarr v. 12.0 it is possible to create the main pages of your module with the Module Builder. To activate it:		From Dolibarr v. 12.0 it is possible to create the main pages of your module with the Module Builder. To activate it:

	Go into the list of module and enable the module "Module Builder"[[File:Module Builder.png\|alt=Module Builder\|thumb\|~~left~~]]		Go into the list of module and enable the module "Module Builder"[[File:Module Builder.png\|alt=Module Builder\|thumb\|none]]


			Then click on the "bug" image in the top right of screen.[[File:Module Builder icon.png\|alt=Module Builder icon\|left\|thumb]]





	Then click on the "bug" image in the top right of screen.

	[[File:Module Builder icon.png\|alt=Module Builder icon\|left\|thumb]]
	<br />		<br />
	=Template of an External Module=		=Template of an External Module=

Sonikf at 23:00, 23 January 2025

2025-01-23T23:00:18Z

← Older revision		Revision as of 23:00, 23 January 2025
Line 45:		Line 45:

	Then click on the "bug" image in the top right of screen.		Then click on the "bug" image in the top right of screen.

	[[File:Module Builder icon.png\|alt=Module Builder icon\|left\|thumb]]		[[File:Module Builder icon.png\|alt=Module Builder icon\|left\|thumb]]
	<br />		<br />

Sonikf: /* Module creation with the module builder */

2025-01-23T22:59:16Z

Module creation with the module builder

← Older revision		Revision as of 22:59, 23 January 2025
Line 36:		Line 36:

	Go into the list of module and enable the module "Module Builder"[[File:Module Builder.png\|alt=Module Builder\|thumb\|left]]		Go into the list of module and enable the module "Module Builder"[[File:Module Builder.png\|alt=Module Builder\|thumb\|left]]

Sonikf at 22:58, 23 January 2025

2025-01-23T22:58:53Z

← Older revision		Revision as of 22:58, 23 January 2025
Line 33:		Line 33:

	=Module creation with the module builder=		=Module creation with the module builder=
	From Dolibarr 9.0 it is possible to create the main pages of your module with the Module Builder. To activate it:		From Dolibarr v. 12.0 it is possible to create the main pages of your module with the Module Builder. To activate it:

	*Go into the list of module and enable the module "Module Builder",		Go into the list of module and enable the module "Module Builder"[[File:Module Builder.png\|alt=Module Builder\|thumb\|left]]

	~~[[File:Module Builder.png\|alt=Module Builder\|thumb]]~~

	*Then click on the "bug" image in the top right of screen.

	~~[[File:Module Builder.png\|alt=Module Builder\|thumb]]~~




			Then click on the "bug" image in the top right of screen.
			[[File:Module Builder icon.png\|alt=Module Builder icon\|left\|thumb]]
			<br />
	=Template of an External Module=		=Template of an External Module=
	A good model to start development of external module can be found here : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]		A good model to start development of external module can be found here : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

Sonikf: /* Module creation with the module builder */

2025-01-23T22:53:34Z

Module creation with the module builder

← Older revision		Revision as of 22:53, 23 January 2025
Line 37:		Line 37:
	*Go into the list of module and enable the module "Module Builder",		*Go into the list of module and enable the module "Module Builder",

	[[File:~~Mod_builder_2~~.png\|~~400px~~]]		[[File:Module Builder.png\|alt=Module Builder\|thumb]]

	*Then click on the "bug" image in the top right of screen.		*Then click on the "bug" image in the top right of screen.