Loading extra language files: Difference between revisions
From Joomla! Documentation
Marked for translation + Needs review |
Marked this version for translation |
||
| Line 2: | Line 2: | ||
<translate> | <translate> | ||
==Overview== | ==Overview== <!--T:1--> | ||
Many times, you need to load extra language files in your code. An example is loading your component's language file into a module for that component. This example loads a single language file, and appends the results to the existing language strings. Following is the code that helps you do this | Many times, you need to load extra language files in your code. An example is loading your component's language file into a module for that component. This example loads a single language file, and appends the results to the existing language strings. Following is the code that helps you do this | ||
</translate> | </translate> | ||
<translate>==PHP Code==</translate> | <translate>==PHP Code== <!--T:2--></translate> | ||
<source lang="PHP"> | <source lang="PHP"> | ||
| Line 18: | Line 18: | ||
<translate> | <translate> | ||
<!--T:3--> | |||
Following is an explanation of the variables | Following is an explanation of the variables | ||
<!--T:4--> | |||
1. $extension - This is the extension whose language file will be loaded | 1. $extension - This is the extension whose language file will be loaded | ||
<!--T:5--> | |||
2. $base_dir - Should be JPATH_SITE in case you have language files stored elsewhere. Defaults to JPATH_BASE. [optional] | 2. $base_dir - Should be JPATH_SITE in case you have language files stored elsewhere. Defaults to JPATH_BASE. [optional] | ||
<!--T:6--> | |||
3. $language_tag - This is the locale string. Language files for this locale will be loaded. Defaults to the one set in backend. [optional] | 3. $language_tag - This is the locale string. Language files for this locale will be loaded. Defaults to the one set in backend. [optional] | ||
<!--T:7--> | |||
4. $reload - Flag that will force a language to be reloaded if set to true. [optional] | 4. $reload - Flag that will force a language to be reloaded if set to true. [optional] | ||
</translate> | </translate> | ||
| Line 31: | Line 36: | ||
<noinclude> | <noinclude> | ||
<translate> | <translate> | ||
<!--T:8--> | |||
[[Category:Development]] | [[Category:Development]] | ||
[[Category:Languages]] | [[Category:Languages]] | ||
Revision as of 19:51, 2 February 2015
Overview
Many times, you need to load extra language files in your code. An example is loading your component's language file into a module for that component. This example loads a single language file, and appends the results to the existing language strings. Following is the code that helps you do this
PHP Code
$lang = JFactory::getLanguage();
$extension = 'com_helloworld';
$base_dir = JPATH_SITE;
$language_tag = 'en-GB';
$reload = true;
$lang->load($extension, $base_dir, $language_tag, $reload);
Following is an explanation of the variables
1. $extension - This is the extension whose language file will be loaded
2. $base_dir - Should be JPATH_SITE in case you have language files stored elsewhere. Defaults to JPATH_BASE. [optional]
3. $language_tag - This is the locale string. Language files for this locale will be loaded. Defaults to the one set in backend. [optional]
4. $reload - Flag that will force a language to be reloaded if set to true. [optional]