J4.x:Creating a Simple Module - Revision history

Robbiej: Added deprecation notice and link to Joomla Manual

2024-06-27T12:23:25Z

Added deprecation notice and link to Joomla Manual

← Older revision		Revision as of 12:23, 27 June 2024
Line 1:		Line 1:
	<noinclude><languages /></noinclude>		<noinclude><languages /></noinclude>

			{{Warning\|With the move of developer documentation to the Joomla Manual, this page is unlikely to be actively maintained. A similar tutorial is available at [https://manual.joomla.org/docs/building-extensions/modules/module-development-tutorial/ Joomla Manual Module Development Tutorial]}}

	{{Joomla version\|version=4.x\|comment=><translate><!--T:1--> Tutorial</translate>}}		{{Joomla version\|version=4.x\|comment=><translate><!--T:1--> Tutorial</translate>}}
	{{-}}		{{-}}

Cmb: Several markup and capitalization changes. Some Words2Watch changes.

2023-04-30T17:28:16Z

Several markup and capitalization changes. Some Words2Watch changes.

Show changes

Rjharishabh: Typo

2021-05-22T18:07:21Z

Typo

← Older revision		Revision as of 18:07, 22 May 2021
Line 780:		Line 780:
	*/		*/
	function install($parent) {		function install($parent) {
	echo Text::_('~~MOD_FOO_INSTALLERSCRIPT_UNINSTALL~~');		echo Text::_('MOD_FOO_INSTALLERSCRIPT_INSTALL');

	return true;		return true;

Partic: Updated language file information in this section.

2020-11-02T05:11:40Z

Updated language file information in this section.

← Older revision		Revision as of 05:11, 2 November 2020
Line 167:		Line 167:
	=== Creating the language files === <!--T:50-->		=== Creating the language files === <!--T:50-->
	</translate>		</translate>
	<translate><!--T:51--> The files <tt>language/en-GB/~~en-GB.~~mod_foo.ini</tt> and <tt>language/en-GB/~~en-GB.~~mod_foo.sys.ini</tt> are used to translate text in the frontend and in the backend.</translate>		<translate><!--T:51--> The files <tt>language/en-GB/mod_foo.ini</tt> and <tt>language/en-GB/mod_foo.sys.ini</tt> are used to translate text in the frontend and in the backend. Note that the language file structure has been updated in Joomla 4, and language prefixes on the individual files in a language folder are no longer required.</translate>

	<translate><!--T:52--> The code for <tt>language/en-GB/~~en-GB.~~mod_foo.sys.ini</tt> is as follows:</translate>		<translate><!--T:52--> The code for <tt>language/en-GB/mod_foo.sys.ini</tt> is as follows:</translate>

	<source lang="xml">		<source lang="xml">
Line 178:		Line 178:
	</source>		</source>

	<translate><!--T:204--> The code for <tt>language/en-GB/~~en-GB.~~mod_foo.ini</tt> is as follows:</translate>		<translate><!--T:204--> The code for <tt>language/en-GB/mod_foo.ini</tt> is as follows:</translate>

	<source lang="xml">		<source lang="xml">
Line 192:		Line 192:

	<translate>		<translate>

	== Test your module == <!--T:55-->		== Test your module == <!--T:55-->
	</translate>		</translate>

Partic: Language file name structure has changed in Joomla 4 - does not need the file prefix for the language.

2020-11-02T05:00:41Z

Language file name structure has changed in Joomla 4 - does not need the file prefix for the language.

← Older revision		Revision as of 05:00, 2 November 2020
Line 54:		Line 54:
	<translate><!--T:28--> * <tt>mod_foo.xml</tt> - This file contains information about the module. It defines the files that need to be installed by the Joomla! installer and specifies configuration parameters for the module.</translate>		<translate><!--T:28--> * <tt>mod_foo.xml</tt> - This file contains information about the module. It defines the files that need to be installed by the Joomla! installer and specifies configuration parameters for the module.</translate>
	<translate><!--T:29--> * <tt>tmpl/default.php</tt> - This is the module template. This file will take the data collected by mod_foo.php and generate the HTML to be displayed on the page.</translate>		<translate><!--T:29--> * <tt>tmpl/default.php</tt> - This is the module template. This file will take the data collected by mod_foo.php and generate the HTML to be displayed on the page.</translate>
	<translate><!--T:30--> * <tt>language/en-GB/~~en-GB.~~mod_foo.ini</tt> and <tt>language/en-GB/~~en-GB.~~mod_foo.sys.ini</tt>- This are the files that provide the text in United Kingdom English.</translate>		<translate><!--T:30--> * <tt>language/en-GB/mod_foo.ini</tt> and <tt>language/en-GB/mod_foo.sys.ini</tt>- This are the files that provide the text in United Kingdom English.</translate>

	<translate>		<translate>

	=== Creating mod_foo.php === <!--T:31-->		=== Creating mod_foo.php === <!--T:31-->
	</translate>		</translate>

Partic: Updated version notes in requirements section.

2020-11-02T04:59:30Z

Updated version notes in requirements section.

← Older revision		Revision as of 04:59, 2 November 2020
Line 30:		Line 30:
	=== Requirements === <!--T:18-->		=== Requirements === <!--T:18-->
	</translate>		</translate>
	<translate><!--T:19--> You need Joomla! 4.x for this tutorial (~~as of writing currently Joomla! 4~~.~~0.0-alpha6~~-~~dev~~)</translate>		<translate><!--T:19--> You need Joomla! 4.x installation available to use for this tutorial ([https://github.com/joomla/joomla-cms/releases Download latest release here])</translate>

	<translate><!--T:20--> You can download Joomla! 4 at [https://github.com/joomla/joomla-cms/~~tree/4.0-dev~~ GitHub], on the [https://developer.joomla.org/nightly-builds.html Developer website] or you can create a free website at https://launch.joomla.org.</translate>		<translate><!--T:20--> You can download Joomla! 4 at [https://github.com/joomla/joomla-cms/releases GitHub], on the [https://developer.joomla.org/nightly-builds.html Developer website] or you can create a free website at https://launch.joomla.org.</translate>

	<translate>		<translate>

	== Creating a simple module/Developing a Basic Module - Part 1 == <!--T:21-->		== Creating a simple module/Developing a Basic Module - Part 1 == <!--T:21-->
	</translate>		</translate>

Sed1037: In T121 replaced an with a for typo

2019-10-19T19:17:39Z

In T121 replaced an with a for typo

← Older revision		Revision as of 19:17, 19 October 2019
Line 597:		Line 597:
	=== Editing tmpl/default.php === <!--T:120-->		=== Editing tmpl/default.php === <!--T:120-->
	</translate>		</translate>
	<translate><!--T:121--> We can use the value of the parameter for creating an hyperlink in the frontend. We can access the value via the variable $params.</translate>		<translate><!--T:121--> We can use the value of the parameter for creating a hyperlink in the frontend. We can access the value via the variable $params.</translate>

	<source lang="php">$domain = $params->get('domain', 'https://www.joomla.org');</source>		<source lang="php">$domain = $params->get('domain', 'https://www.joomla.org');</source>

Sed1037: In T28 begin changec to begining

2019-10-19T18:31:44Z

In T28 begin changec to begining

← Older revision		Revision as of 18:31, 19 October 2019
Line 298:		Line 298:
	=== Editing mod_foo.php === <!--T:81-->		=== Editing mod_foo.php === <!--T:81-->
	</translate>		</translate>
	<translate><!--T:82--> Our new helper class is imported to our current scope at the ~~begin~~ of the file.</translate>		<translate><!--T:82--> Our new helper class is imported to our current scope at the beginning of the file.</translate>

	<source lang="php">use Joomla\Module\Foo\Site\Helper\FooHelper;</source>		<source lang="php">use Joomla\Module\Foo\Site\Helper\FooHelper;</source>

Lorangerart: Typo issue

2019-07-23T06:49:32Z

Typo issue

← Older revision		Revision as of 06:49, 23 July 2019
Line 992:		Line 992:
	=== Joomla Updater === <!--T:178-->		=== Joomla Updater === <!--T:178-->
	</translate>		</translate>
	<translate><!--T:179--> The first thing to do is to read the [[S:MyLanguage/J2.5:Managing_Component_Updates\|Managing Component Upgrades with Joomla 2.5 - Part 1]] tutorial to give an idea of how the upgrade process works in ~~Joomla~~. Whilst written for 2.5 the process hasn't changed. Also read [[S:MyLanguage/Deploying_an_Update_Server\|Deploying an update server]] - this is what we'll be implementing in this tutorial.</translate>		<translate><!--T:179--> The first thing to do is to read the [[S:MyLanguage/J2.5:Managing_Component_Updates\|Managing Component Upgrades with Joomla 2.5 - Part 1]] tutorial to give an idea of how the upgrade process works in Joomlaǃ. Whilst written for 2.5 the process hasn't changed. Also read [[S:MyLanguage/Deploying_an_Update_Server\|Deploying an update server]] - this is what we'll be implementing in this tutorial.</translate>

	<translate>		<translate>
Line 998:		Line 998:
	</translate>		</translate>
	<translate><!--T:181--> We will create/change the following files:</translate>		<translate><!--T:181--> We will create/change the following files:</translate>
	<translate><!--T:182--> * <tt>mod_foo.xml</tt> - The only way to update our existing module is to add in a update server - for example <tt><nowiki>http://www.example.com/foo_update.~~xmɭ~~</nowiki></tt> - into the xml file.</translate>		<translate><!--T:182--> * <tt>mod_foo.xml</tt> - The only way to update our existing module is to add in a update server - for example <tt><nowiki>http://www.example.com/foo_update.xml</nowiki></tt> - into the xml file.</translate>
	<translate><!--T:183--> * <tt>foo_update.xml</tt> - Then we have to create the XML file for the update server at <tt><nowiki>http://www.example.com/foo_update.~~xmɭ~~</nowiki></tt> to let Joomla know an update is available.</translate>		<translate><!--T:183--> * <tt>foo_update.xml</tt> - Then we have to create the XML file for the update server at <tt><nowiki>http://www.example.com/foo_update.xml</nowiki></tt> to let Joomla know an update is available.</translate>

	<translate>		<translate>
	==== Editing mod_foo.xml ==== <!--T:184-->		==== Editing mod_foo.xml ==== <!--T:184-->
	</translate>		</translate>
	<translate><!--T:185--> To add our update server, we need to insert the following lines in your XML-~~File~~</translate>		<translate><!--T:185--> To add our update server, we need to insert the following lines in your XML-Fileː</translate>

	<source lang="php">		<source lang="php">
Line 1,095:		Line 1,095:
	</source>		</source>

	<translate><!--T:188--> So now that ~~Joomla~~ is searching for updates to our extension - let's create one to test out our process. But first we need to create the file <tt>foo_update.xml</tt>. So far we have only described the update server. We do not know yet if there is an update. In the file <tt>foo_update.xml</tt> we indicate when a new version is published and where it can be downloaded.</translate>		<translate><!--T:188--> So now that Joomlaǃ is searching for updates to our extension - let's create one to test out our process. But first we need to create the file <tt>foo_update.xml</tt>. So far we have only described the update server. We do not know yet if there is an update. In the file <tt>foo_update.xml</tt> we indicate when a new version is published and where it can be downloaded.</translate>

	<translate>		<translate>
Line 1,144:		Line 1,144:
	=== Conclusion === <!--T:198-->		=== Conclusion === <!--T:198-->
	</translate>		</translate>
	<translate><!--T:199--> With the ~~Joomla~~ updater, you can easily reach all users and tell them that there is a new version. Even the update itself is easy.</translate>		<translate><!--T:199--> With the Joomlaǃ updater, you can easily reach all users and tell them that there is a new version. Even the update itself is easy.</translate>

	<translate><!--T:200--> Each extension should use an update server. Especially for security reasons.</translate>		<translate><!--T:200--> Each extension should use an update server. Especially for security reasons.</translate>

Lorangerart: Typo issue

2019-07-22T15:08:39Z

Typo issue

← Older revision		Revision as of 15:08, 22 July 2019
Line 727:		Line 727:
	=== Creating script.php === <!--T:154-->		=== Creating script.php === <!--T:154-->
	</translate>		</translate>
	<translate><!--T:155--> Writing an extension script consists in declaring a class whose name is <tt>~~mod_ModuleNameInstallerScripʈ~~</tt> with these 5 methods. See the comments in the file for more information. In this comments I explain when a method is called.</translate>		<translate><!--T:155--> Writing an extension script consists in declaring a class whose name is <tt>mod_ModuleNameInstallerScript</tt> with these 5 methods. See the comments in the file for more information. In this comments I explain when a method is called.</translate>

	<translate><!--T:156--> In this example, I only use text to show when which method will be executed. In addition, I show you how to check the minimum requirements. Of course you can do much more. For example, you can delete files that are no longer needed in a new version of your module. This can be seen in the file. Another idea for this file is to create sample content, to show a success message with the current installed version number or you can redirect after a successful installation to the page with the module settings.</translate>		<translate><!--T:156--> In this example, I only use text to show when which method will be executed. In addition, I show you how to check the minimum requirements. Of course you can do much more. For example, you can delete files that are no longer needed in a new version of your module. This can be seen in the file. Another idea for this file is to create sample content, to show a success message with the current installed version number or you can redirect after a successful installation to the page with the module settings.</translate>
Line 850:		Line 850:
	return true;		return true;
	}		}

	}		}