Joomla! Documentation - User contributions [en]

Subform form field type

2017-09-11T17:11:37Z

Waveywhite: Made it clear that that the relative path for the xml file is relative to the installation folder, because the previous text implied that it was relative to the path of the including file.

<noinclude><languages /></noinclude>
<translate>
The '''subform''' form field type provides a method for using XML forms inside one another or reuse forms inside an existing form.</translate>
<translate>
If attribute '''multiple''' is set to '''true''' then the included form will be '''repeatable'''.</translate>

<translate>
The Field has two "predefined" layouts for displaying the subform as either a '''table''' or as a '''div''' container, as well as support for custom layouts.</translate>

<translate>
An example XML '''field''' definition for '''single''' mode:</translate>

<source lang="xml"><field name="field-name" type="subform"
formsource="path/to/exampleform.xml"
label="Subform Field" description="Subform Field Description" /></source>

<translate>
An example XML '''field''' definition for '''multiple''' mode:</translate>

<source lang="xml"><field name="field-name" type="subform"
formsource="path/to/exampleform.xml" multiple="true"
label="Subform Field" description="Subform Field Description" /></source>

<translate>
Example XML of ''exampleform.xml''</translate>

<source lang="xml"><?xml version="1.0" encoding="UTF-8"?>
<form>
<field name="example_text" type="text" label="Example Text" />
<field name="example_textarea" type="textarea" label="Example Textarea" cols="40" rows="8" />
</form></source>

<translate>
An example XML of ''exampleform.xml'' with ''fieldsets''</translate>

<source lang="xml"><?xml version="1.0" encoding="UTF-8"?>
<form>
<fieldset name="section1" label="Section1">
<field name="example_text" type="text" label="Example Text" />
<field name="example_textarea" type="textarea" label="Example Textarea" cols="40" rows="8" />
</fieldset>
<fieldset name="section2" label="Section2">
<field name="example_list" type="list" default="1" class="advancedSelect" label="Example List">
<option value="1">JYES</option>
<option value="0">JNO</option>
</field>
</fieldset>
</form></source>

<translate>

Field attributes:</translate>
<translate>

* '''type''' (mandatory) must be ''subform''.</translate>
<translate>

* '''name''' (mandatory) is the unique name of the field.</translate>
<translate>

* '''label''' (mandatory) (translatable) is the descriptive title of the field.</translate>
<translate>

* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.</translate>
<translate>

* '''required''' (optional) The field must be filled before submitting the form.</translate>
<translate>

* '''message''' (optional) The error message that will be displayed instead of the default message.</translate>
<translate>

* '''default''' (optional) is the default value, JSON string.</translate>
<translate>

* '''formsource''' (mandatory) the form source to be included. A relative path to the xml file (relative to the root folder for the installed Joomla site) or a valid form name which can be found by ''JForm::getInstance()''.</translate>
<translate>

* '''multiple''' (optional) whether the subform fields are repeatable or not.</translate>
<translate>

* '''min''' (optional) count of minimum repeating in multiple mode. Default: ''0''.</translate>
<translate>

* '''max''' (optional) count of maximum repeating in multiple mode. Default: ''1000''.</translate>
<translate>

* '''groupByFieldset''' (optional) whether to group the subform fields by its fieldset (''true'' or ''false''). Default: ''false''.</translate>
<translate>

* '''buttons''' (optional) which buttons to show in multiple mode. Default: ''add,remove,move''.</translate>
<translate>

* '''layout''' (optional) the name of the layout to use when displaying '''subform''' fields.</translate>

<translate>

Available layouts:</translate>
<translate>

* '''joomla.form.field.subform.default''' render the subform in a div container, without support of repeating. Default for single mode.</translate>
<translate>

* '''joomla.form.field.subform.repeatable''' render the subform in a div container, used for multiple mode. Support groupByFieldset.</translate>
<translate>

* '''joomla.form.field.subform.repeatable-table''' render the subform as a table, used for multiple mode. Supports groupByFieldset. By default each field is rendered as a table column, but if ''groupByFieldset=true'' then each fieldset is rendered as a table column.</translate>

<translate>

'''Be aware'''</translate>

<translate>

If your field in the subform has additional JavaScript logic then it may not work in '''multiple''' mode, because do not see the fields which added by the subform field dynamically. If it happened then you need to adjust your field to support it.</translate>
<translate>

Next example may help:</translate>

<source lang="javascript">jQuery(document).ready(function(){
... here the code for setup your field as usual...

jQuery(document).on('subform-row-add', function(event, row){
... here is the code to set up the fields in the new row ...
})
});
</source>

<translate>
Because of this some extra Joomla! fields may not work for now.


Subform not provide the Validation and Filter.</translate>

<translate>
== Example == 
</translate>

<translate>
'''Problem '''</translate>

<translate>
After adding new rows selects are not "chosen".</translate>
<translate>
See screenshot to get the idea of the problem http://static.xscreenshot.com/2016/10/29/18/screen_6917fc3c8d3c5d679b6442ff249a7b5f</translate>

<translate>

'''Solution '''
</translate>

<translate>
Here is an example how to reinit jQuery Chosen on newly added repeated rows:</translate>

<source lang="javascript">jQuery(document).ready(function(){
jQuery(document).on('subform-row-add', function(event, row){
jQuery(row).find('select').chosen();
})
});
</source>

<translate>
Or a PHP snippet to be used in e.g. your plugin in **onBeforeCompileHead** method or in your component view.</translate>

<source lang="php">
$doc = JFactory::getDocument();
$js = '
jQuery(document).on(\'subform-row-add\', function(event, row){
jQuery(row).find(\'select\').chosen();
})
';
$doc->addScriptDeclaration($js);
</source>

<translate>
So newly added rows now are "chosen" now http://static.xscreenshot.com/2016/10/29/18/screen_8f7dc7709899bac7a43926828e504519</translate>

<translate>
=== See also === </translate>
<translate>

* [[S:MyLanguage/Standard form field types|List of standard form field types]]
</translate>

<noinclude>
<translate>

[[Category:Standard form field types]]
</translate>
</noinclude>

Package

2015-04-07T11:00:43Z

Waveywhite: Added details on the version number parameter for the extension tag

<noinclude><languages /></noinclude>
<translate>
== Note on component dependant modules== 


Sometimes modules (or plugins etc.) use a component's models and helpers and such. In these occasions it would be nice to be able to package your module in this way that it gets uninstalled when the component itself gets uninstalled. This is called dependency management which has been desired in joomla but hasn't been done yet.
It is suggested to follow the standards and just using a package as is described below.
</translate>

<translate>
== What is a package? == 


A package is a extension that is used to install multiple extensions in one go. This is used if you have for example a component and a module that are depending on each other. Combining them in a package will let the user install and uninstall both extensions in one go. Package extensions can be used with Joomla {{JVer|2.5}} and higher.
</translate>

<translate>
== How do I create a package? == 


A package extension is created by zipping all zip files of the extensions together with a xml manifest file. For example if you have a package composed by:
</translate>

<translate>

* '''component''' helloworld
* '''module''' helloworld
* '''library''' helloworld
* '''system plugin''' helloworld
* '''template''' helloworld


The package should have the following tree in your zipfile:
</translate>

-- pkg_helloworld.xml
-- packages <dir>
|-- com_helloworld.zip
|-- mod_helloworld.zip
|-- lib_helloworld.zip
|-- plg_sys_helloworld.zip
|-- tpl_helloworld.zip

<translate>

The pkg_helloworld.xml could have the following contents:
</translate>

<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<extension type="package" version="1.6" method="upgrade">
<name>Hello World Package</name>
<author>Hello World Package Team</author>
<creationDate>May 2012</creationDate>
<packagename>helloworld</packagename>
<version>1.0.0</version>
<url>http://www.yoururl.com/</url>
<packager>Hello World Package Team</packager>
<packagerurl>http://www.yoururl.com/</packagerurl>
<description>Example package to combine multiple extensions</description>
<update>http://www.updateurl.com/update</update>
<files folder="packages">
<file type="component" id="com_helloworld" >com_helloworld.zip</file>
<file type="module" id="helloworld" client="site">mod_helloworld.zip</file>
<file type="library" id="helloworld">lib_helloworld.zip</file>
<file type="plugin" id="helloworld" group="system">plg_sys_helloworld.zip</file>
<file type="template" id="helloworld" client="site">tpl_helloworld.zip</file>
</files>
</extension>
</source>

<translate>

When you zip this and try to install it, you will see that every extension will be installed. Also the package will be visible in the extension list to uninstall all the extension of this package.
</translate>

<translate>

Remember to use the package uninstaller instead of individual subpackage uninstallers to avoid orphan extension entries in the extension manager.
</translate>

<translate>
=== Id= <file id="not_arbitrary"> === 
The id element in <file ..> tag are NOT arbitrary!. The "id=" should be set to the value of the "element" column in the "#__extensions" table. If they are not set correctly, upon uninstalling of the package the children ( <file> ) will NOT be found and uninstalled.
</translate>

<translate>
=== Manifest filename and packagename === 
The naming of the manifest file and the ability to uninstall the package file itself are closely related.
The manifest file must have a "pkg_" prefix, the remainder of the manifest name ( without .xml extension ) is to be used as <packagename>. Or, the other way around, a package you want to identify as "blurpblurp_J3" get that as its <packagename> and should be in a manifest file named "pkg_blurpblurp_J3.xml". Failure to do so will make it impossible to uninstall the package itself.


=== Extension tag ===
As of Joomla 3.4, you should include method="upgrade" in the <extension> tag if you wish for your package to succeed in updating itself on subsequent installations.

The version attribute of the <extension> tag should be set to the minimum supported version of Joomla for this package. For example, if your package only supports Joomla 3.2 and above set this to 3.2.
</translate>

<translate>

[[Category:Extensions]]
</translate>

Plugin/Events

2014-02-25T13:52:19Z

Waveywhite: /* User */

<noinclude>{{version/tutor|2.5,3.x}}</noinclude>
Joomla! ships with a variety of core events, organised into groups. These are described in the following topics.

=== Authentication ===
* [[Plugin/Events/User#onUserAuthenticate|onUserAuthenticate]]

=== Captcha ===
* [[Plugin/Events/Editor#onInit|onInit]]
* [[Plugin/Events/Editor#onDisplay|onDisplay]]
* [[Plugin/Events/Captcha#onCheckAnswer|onCheckAnswer]]

=== Content ===
* [[Plugin/Events/Content#onContentPrepare|onContentPrepare]]
* [[Plugin/Events/Content#onContentAfterTitle|onContentAfterTitle]] ({{JVer|3.x}} only)
* [[Plugin/Events/Content#onContentBeforeDisplay|onContentBeforeDisplay]]
* [[Plugin/Events/Content#onContentAfterDisplay|onContentAfterDisplay]]
* [[Plugin/Events/Content#onContentBeforeSave|onContentBeforeSave]]
* [[Plugin/Events/Content#onContentAfterSave|onContentAfterSave]]
* [[Plugin/Events/Content#onContentPrepareForm|onContentPrepareForm]]
* [[Plugin/Events/Content#onContentPrepareData|onContentPrepareData]]
* [[Plugin/Events/Content#onContentBeforeDelete|onContentBeforeDelete]]
* [[Plugin/Events/Content#onContentAfterDelete|onContentAfterDelete]]
* [[Plugin/Events/Content#onContentChangeState|onContentChangeState]]
* [[Plugin/Events/Content#onContentSearch|onContentSearch]]
* [[Plugin/Events/Content#onContentSearchAreas|onContentSearchAreas]]

=== Editors ===
* [[Plugin/Events/Editor#onInit|onInit]]
* [[Plugin/Events/Editor#onSave|onSave]]
* [[Plugin/Events/Editor#onSetContent|onSetContent]]
* [[Plugin/Events/Editor#onDisplay|onDisplay]]
* [[Plugin/Events/Editor#onGetContent|onGetContent]]
* [[Plugin/Events/Editor#onGetInsertMethod|onGetInsertMethod]]

=== Extensions ===
* [[Plugin/Events/Extension#onExtensionAfterInstall|onExtensionAfterInstall]]
* [[Plugin/Events/Extension#onExtensionAfterUninstall|onExtensionAfterUninstall]]
* [[Plugin/Events/Extension#onExtensionAfterUpdate|onExtensionAfterUpdate]]

=== Finder ===
* [[Plugin/Events/Finder#onFinderCategoryChangeState|onFinderCategoryChangeState]]
* [[Plugin/Events/Finder#onFinderChangeState|onFinderChangeState]]
* [[Plugin/Events/Finder#onFinderBeforeDelete|onFinderAfterDelete]]
* [[Plugin/Events/Finder#onFinderAfterDelete|onFinderAfterDelete]]
* [[Plugin/Events/Finder#onFinderBeforeSave|onFinderBeforeSave]]
* [[Plugin/Events/Finder#onFinderAfterSave|onFinderAfterSave]]

=== Quick Icons ===
* [[Plugin/Events/Quickicon#onGetIcons|onGetIcons]]

=== System ===
* [[Plugin/Events/System#onAfterInitialise|onAfterInitialise]]
* [[Plugin/Events/System#onAfterRoute|onAfterRoute]]
* [[Plugin/Events/System#onAfterDispatch|onAfterDispatch]]
* [[Plugin/Events/System#onAfterRender|onAfterRender]]
* [[Plugin/Events/System#onBeforeRender|onBeforeRender]]
* [[Plugin/Events/System#onBeforeCompileHead|onBeforeCompileHead]]
* [[Plugin/Events/System#onSearch|onSearch]]
* [[Plugin/Events/System#onSearchAreas|onSearchAreas]]

=== User ===
* [[Plugin/Events/User#onUserBeforeSave|onUserBeforeSave]]
* [[Plugin/Events/User#onUserAfterSave|onUserAfterSave]]
* [[Plugin/Events/User#onUserBeforeDelete|onUserBeforeDelete]]
* [[Plugin/Events/User#onUserAfterDelete|onUserAfterDelete]]
* [[Plugin/Events/User#onUserLogin|onUserLogin]]
* [[Plugin/Events/User#onUserLoginFailure|onUserLoginFailure]]
* [[Plugin/Events/User#onUserAfterLogin|onUserAfterLogin]]
* [[Plugin/Events/User#onUserLogout|onUserLogout]]
* [[Plugin/Events/User#onUserAuthenticate|onUserAuthenticate]]
* [[Plugin/Events/User#onUserAuthorisation|onUserAuthorisation]]

<noinclude>[[Category:Plugin Development|Events]][[Category:Specifications]]
[[Category:Tutorials]]
</noinclude>

Adding custom fields to core components using a plugin

2014-02-25T12:24:17Z

Waveywhite:

Have you ever wished that there was an extra phone number field in com_contact or needed an extra field for articles in com_content? Joomla provides a straight-foward way of integrating new fields with core components such as these. All it takes to achieve this is a simple content plugin and a layout override in your template.

This article shows how to add an extra field to a core component using the example of adding an additional email address to contacts in com_contact.

==Adding a custom field==

It is recommended that you first read [[Creating a Plugin for Joomla]] for details on how to create and install a plugin, which is not covered here.

To add a field to a system component you need to create a content plugin which picks up the onContentPrepareForm event and inserts it's own fields into the given JForm. The following code is for Joomla 3.1 and later, for Joomla 2.5 the language files need to be loaded in the constructor (see [[J2.5:Creating a Plugin for Joomla]]).

<source lang="php">
<?php
// no direct access
defined ( '_JEXEC' ) or die ( 'Restricted access' );

class plgContentExample extends JPlugin {

/**
* Load the language file on instantiation.
* Note this is only available in Joomla 3.1 and higher.
* If you want to support 3.0 series you must override the constructor
*
* @var boolean
* @since 3.1
*/

protected $autoloadLanguage = true;

function onContentPrepareForm($form, $data) {
$app = JFactory::getApplication();
$option = $app->input->get('option');

switch($option) {

case 'com_contact':
if ($app->isAdmin()) {
JForm::addFormPath(__DIR__ . '/forms');
$form->loadFile('contact', false);
}
return true;

}
return true;
}

}
?>
</source>

The additional fields are loaded from the file forms/contact.xml in the plugin directory. It's important that these fields are in a fields element with the name property set to "params". If you don't set this property name the fields will appear in the admin site but the values will not be saved.

In this case we are adding a field for a label to describe the email field in the public website and a second field for the value of the email address.

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<form>
<fields name="params" >
<fieldset name="params" >
<field
name="contact_emaillabel2"
type="text"
label="PLG_CONTENT_EXAMPLE_CONTACT_EMAILLABEL2"
/>
<field
name="contact_email2"
type="text"
label="PLG_CONTENT_EXAMPLE_CONTACT_EMAIL2"
filter="email"
/>
</fieldset>
</fields>
</form>
</source>

Finally we need a language file so that the parameters are presnted nicely in the admin site and are translatable into different languages. This file needs to be called something like en-GB.plg_content_example.ini.

<source>
COM_CONTACT_PARAMS_FIELDSET_LABEL="Additional Information"
PLG_CONTENT_EXAMPLE_CONTACT_EMAIL2="Additional email address"
PLG_CONTENT_EXAMPLE_CONTACT_EMAILLABEL2="Additional email label"
</source>

That's it for adding the field to com_contact. If you install this plugin you'll have an additional tab in the contact editing form called "Additional Information" with the new fields included. If you fill in the new label and an email address fields for a contact you'll see that com_contact will store and retrieve the information for you.

The same plugin can be used to add more fields to different components, just add the relevant code into the onContentPrepareForm function and create the appropriate XML form files.

==Displaying the custom field==

To display the custom field you need to create a layout override for the relevant component in your template. For more details on creating templates see [[Creating a basic Joomla! template]], for details on layout overrides see [[Understanding Output Overrides]].

Copy the file <Joomla>/components/com_contact/views/contact/tmpl/default.php to <template>/html/com_contact/contact/default.php, creating the folders in your template as necessary. We're going to edit this file to include the additional information. The com_contact component will automatically load the additional fields for us and load it into a variable called $thiis->params. All we need to do is check that the data is set and, if so, display it.

To display the field, find the location in <template>/html/com_contact/contact/default.php that corresponds to where you'd like the additional email address to be displayed and add the following code

<source lang="php">
<?php if ($this->params->get('contact_emaillabel2', false)) : ?>
<div>
<span class="contact-additionalemail"><?php echo $this->params->get('contact_emaillabel2');?>:&emsp;<a href="mailto:<?php echo $this->params->get('contact_email2'); ?>"><?php echo $this->params->get('contact_email2'); ?></a><br/></span>
</div>
<?php endif; ?>
</source>

If you add this code and install your template you will now have the custom field displaying in your public website.
[[Category:Plugin Development]] [[Category:Template Development]] [[Category:Tutorials]]

Portal:Plugin Development/Projects

2014-02-25T12:18:47Z

Waveywhite:

== Plugin Development Articles Needed ==
The Joomla! Documentation Wiki needs your help! Below is a list of pages/articles needed for Plugin Development. If you know of a topic which needs to be addressed, just add it to the '''List of Red Links''' below by using the following wikimarkup.
{{amboxNew|image=jdoc|text=To add a '''Red Link''' {{edit|Portal:Plugin_Development/Projects|click here}} and add it to the '''Plugins Development Projects page'''. Please use the following wikimarkup code to add the suggested topic to the list:
:<code><nowiki>*[[Put your Plugin Article name here]]</nowiki></code>|title=Want or Need a New Article on Plugin Development?}}

List of Red Links for needed '''Plugin Develepment''' Articles:

<noinclude>[[Category:Landing subpages|{{PAGENAME}}]]</noinclude>

Portal:Plugin Development/Using Plugins

2014-02-25T12:17:48Z

Waveywhite: /* Using Plugins */

==Using Plugins==

Plugins are grouped together depending on which event they run on. A full list of events grouped by event type can be found [[Plugin/Events|here]] (the names of a lot of events changed between {{JVer|1.5}} and {{JVer|2.5}} see [[J2.5:Adapting_a_Joomla_1.5_extension_to_Joomla_2.5#Renamed_Events|here]] for a full list of changes). There are also several simple tutorials on making some sample plugins running on some of these events to help running searches on extensions using both the search and smart search components:

* [[Creating a search plugin]]
* [[Creating a Smart Search plug-in]] ({{JVer|2.5}} only)

There are further tutorials using the user triggers on how to create an authentication plugin to help users log into Joomla and creating a profile plugin for Joomla.

* [[Creating an Authentication Plugin for Joomla]]
* [[Creating a profile plugin]]

Content plugins can be used to add custom fields to core components. The following tutorial explains how to do this and how to display the new field on your webite.

* [[Adding custom fields to core components using a plugin]]

A more complex example of [[Creating a System Plugin to augment JRouter|using plugins to create a new system router]] to produce URLs is also available ({{JVer|2.5}} only).
<noinclude>[[Category:Landing subpages|{{PAGENAME}}]]</noinclude>

Adding custom fields to core components using a plugin

2014-02-25T12:13:25Z

Waveywhite: How to add custom fields to a core component and display them on your website.

Adding custom fields to core components using a plugin

2014-02-25T12:09:32Z

Waveywhite:

Have you ever wished that there was an extra phone number field in com_contact or needed an extra field for articles in com_content? Joomla provides a straight-foward way of integrating new fields with core components such as these. All it takes to achieve this is a simple content plugin and a layout override in your template.

This article shows how to add an extra field to a core component using the example of adding an additional email address to contacts in com_contact.

==Adding a custom field==

It is recommended that you first read [[Creating a Plugin for Joomla]] for details on how to create and install a plugin, which is not covered here.

To add a field to a system component you need to create a content plugin which picks up the onContentPrepareForm event and inserts it's own fields into the given JForm. The following code is for Joomla 3.1 and later, for Joomla 2.5 the language files need to be loaded in the constructor (see [[J2.5:Creating a Plugin for Joomla]]).

<source lang="php">
<?php
// no direct access
defined ( '_JEXEC' ) or die ( 'Restricted access' );

class plgContentExample extends JPlugin {

/**
* Load the language file on instantiation.
* Note this is only available in Joomla 3.1 and higher.
* If you want to support 3.0 series you must override the constructor
*
* @var boolean
* @since 3.1
*/

protected $autoloadLanguage = true;

function onContentPrepareForm($form, $data) {
$app = JFactory::getApplication();
$option = $app->input->get('option');

switch($option) {

case 'com_contact':
if ($app->isAdmin()) {
JForm::addFormPath(__DIR__ . '/forms');
$form->loadFile('contact', false);
}
return true;

}
return true;
}

}
?>
</source>

The additional fields are loaded from the file forms/contact.xml in the plugin directory. It's important that these fields are in a fields element with the name property set to "params". If you don't set this property name the fields will appear in the admin site but the values will not be saved.

In this case we are adding a field for a label to describe the email field in the public website and a second field for the value of the email address.

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<form>
<fields name="params" >
<fieldset name="params" >
<field
name="contact_emaillabel2"
type="text"
label="PLG_CONTENT_EXAMPLE_CONTACT_EMAILLABEL2"
/>
<field
name="contact_email2"
type="text"
label="PLG_CONTENT_EXAMPLE_CONTACT_EMAIL2"
filter="email"
/>
</fieldset>
</fields>
</form>
</source>

Finally we need a language file so that the parameters are presnted nicely in the admin site and are translatable into different languages. This file needs to be called something like en-GB.plg_content_example.ini.

<source>
COM_CONTACT_PARAMS_FIELDSET_LABEL="Additional Information"
PLG_CONTENT_EXAMPLE_CONTACT_EMAIL2="Additional email address"
PLG_CONTENT_EXAMPLE_CONTACT_EMAILLABEL2="Additional email label"
</source>

That's it for adding the field to com_contact. If you install this plugin you'll have an additional tab in the contact editing form called "Additional Information" with the new fields included. If you fill in the new label and an email address fields for a contact you'll see that com_contact will store and retrieve the information for you.

The same plugin can be used to add more fields to different components.

==Displaying the custom field==

To display the custom field you need to create a layout override for the relevant component in your template. For more details on creating templates see [[Creating a basic Joomla! template]], for details on layout overrides see [[Understanding Output Overrides]].

Copy the file <Joomla>/components/com_contact/views/contact/tmpl/default.php to <template>/html/com_contact/contact/default.php, creating the folders in your template as necessary. We're going to edit this file to include the additional information. The com_contact component will automatically load the additional fields for us and load it into a variable called $thiis->params. All we need to do is check that the data is set and, if so, display it.

To display the field, find the location in <template>/html/com_contact/contact/default.php that corresponds to where you'd like the additional email address to be displayed and add the following code

<source lang="php">
<?php if ($this->params->get('contact_emaillabel2', false)) : ?>
<div>
<span class="contact-additionalemail"><?php echo $this->params->get('contact_emaillabel2');?>:&emsp;<a href="mailto:<?php echo $this->params->get('contact_email2'); ?>"><?php echo $this->params->get('contact_email2'); ?></a><br/></span>
</div>
<?php endif; ?>
</source>

If you add this code and install your template you will now have the custom field displaying in your public website.

Adding custom fields to core components using a plugin

2014-02-25T11:40:24Z

Waveywhite: Created page with "Have you ever wished that there was an extra phone number field in com_contact or needed an extra field for articles in com_content? Joomla provides a straight-foward way of i..."

Portal:Plugin Development/Projects

2014-02-05T08:58:55Z

Waveywhite: Added a placeholder for a plugin article I'm intending to write.

== Plugin Development Articles Needed ==
The Joomla! Documentation Wiki needs your help! Below is a list of pages/articles needed for Plugin Development. If you know of a topic which needs to be addressed, just add it to the '''List of Red Links''' below by using the following wikimarkup.
{{amboxNew|image=jdoc|text=To add a '''Red Link''' {{edit|Portal:Plugin_Development/Projects|click here}} and add it to the '''Plugins Development Projects page'''. Please use the following wikimarkup code to add the suggested topic to the list:
:<code><nowiki>*[[Put your Plugin Article name here]]</nowiki></code>|title=Want or Need a New Article on Plugin Development?}}

List of Red Links for needed '''Plugin Develepment''' Articles:
*[[Adding custom fields to core components using a plugin]]
<noinclude>[[Category:Landing subpages|{{PAGENAME}}]]</noinclude>

Usergroup form field type

2013-11-04T16:56:13Z

Waveywhite: Added "multiple" field for multi-select

The '''usergroup''' form field type provides a modal select box of user groups.

* '''type''' (mandatory) must be ''usergroup''.
* '''name''' (mandatory) is the unique name of the field. This must match the name of the query results column that contains the values that will be shown to the user in the drop-down list, unless a different name is specified in the ''value_field'' attribute.
* '''label''' (mandatory) (translatable) is the descriptive title of the field.
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.
* '''class''' (optional) is a CSS class name for the HTML form field.
* '''size''' (optional) is the width of the text box in characters. If omitted the width is determined by the browser. The value of size does not limit the number of characters that may be entered.
* '''multiple''' (optional) If set to ''multiple'' then allows more than one usergroup to be selected.

Implemented by: libraries/joomla/form/fields/usergroup.php

Example user form field definition:
<source type="php">
<field name="guest_usergroup" type="usergroup"
label="COM_USERS_CONFIG_FIELD_GUEST_USER_GROUP_LABEL"
description="COM_USERS_CONFIG_FIELD_GUEST_USER_GROUP_DESC">
default="1" />
</source>

<noinclude>
=== See also ===
* [[Standard form field types|List of standard form field types]]
[[Category:Standard form field types]] </noinclude>

File form field type

2012-11-22T11:30:23Z

Waveywhite:

{{incomplete}}{{review}}
{{Ambox|type=notice|text=In Joomla! 1.5, [[Form field|form fields]] were [[Parameter|parameters]]. For that version, you may want to use the corresponding [[Text parameter type]].}}

Intro: todo

* '''type''' (mandatory) must be ''file''.
* '''name''' (mandatory) is the unique name of the field.
* '''label''' (mandatory) (translatable) is the descriptive title of the field.
* '''default''' (optional) (not translatable) is the default value, but doesn't mean much for a file.
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.
* '''size''' (optional) is the width of the file box in characters.
* [http://www.w3schools.com/tags/att_input_accept.asp '''accept'''] (optional) Tells the browser what MIME types your form will allow to be uploaded.
* '''class''' (optional) is a CSS class name for the HTML form field.
* '''disabled''' (optional) HTML equivalent attribute
* '''onchange''' (optional) HTML equivalent attribute
* '''required''' (optional) For Joomla form validating it to be filled in
* '''validate''' (optional) Whether to Joomla validate the field according to rules
* '''onchange''' (optional) HTML equivalent attribute (javascript use)

'''Note:'''
You should always add the attribute enctype="multipart/form-data" to your form tag when using the file input type. Otherwise, the uploaded files will not be attached correctly.

'''Note 2:'''
You can put a soft limit file size by adding a hidden field with name="MAX_FILE_SIZE" and value the maximum allowed bytes which is handled by php, but you must also handle it in your code with or without it.
Example XML field definition:

<source lang="xml"><field name="myfilevalue" type="file" label="Enter some text" description="Choose an image from your computer with maximum 100KB" size="10" accept="image/*" /></source>

=== See also ===
* [[Media_form_field_type]]
* [[Standard form field types|List of standard form field types]]
[[Category:Standard form field types]]</noinclude>

Checkbox form field type

2012-10-12T19:34:17Z

Waveywhite:

The '''checkbox''' form field type provides a single checkbox. If the parameter has a saved value this is selected when the page is first loaded. If not, the default value (if any) is selected.

* '''type''' (mandatory) must be checkbox
* '''name''' (mandatory) is the unique name of the parameter.
* '''label''' (mandatory) (translatable) is the descriptive title of the field.
* '''value''' (optional) is the value of the parameter if this checkbox is set (usually 1).
* '''default''' (optional) is the default value (usually 0 or 1).
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the label.
* '''class''' (optional) is a CSS class name for the HTML form field. If omitted this will default to 'inputbox'.
<noinclude>
Example XML field definition:

<source lang="xml"><field name="show_title" type="checkbox" label="Show title" description="Show the title of the item" value="1" /></source>

Example XML field definition (unchecked):

<source lang="xml"><field name="show_title" type="checkbox" label="Show title" description="Show the title of the item" value="1" default="0" /></source>

=== See also ===
* [[Standard form field types|List of standard form field types]]
[[Category:Standard form field types]]</noinclude>