Language Files - What are they and how are they used?
Zen Cart uses language files or a “languages system” to define the text content used by the various display pages of your cart.
An obvious benefit of the “languages system” is the ability to run Zen Cart in another language or several languages at the same time. Using these files allows you to edit/change the content that appears on every page of your shop without needing to understand databases or programming languages.
The information in these files can be placed into four categories as follows:
Global information which contains text that is used across the entire site. This information is contained in
Page Specific information contains text used by individual pages in your cart. This information is contained in
Your Own Definitions can contain text you might find necessary in your particular shop. This information is contained in
.php files stored in the folder
Define pages are default pages used by Zen Cart and can be edited as necessary. You can also add your own pages if you find that necessary. These files are located in
includes/languages/english/html_includes/. For more information on this topic, see setting up Define Pages.
The information in language files (other than the define pages described above) is constructed using PHP “define statements,” which consist of a CONSTANT and the information contained in that CONSTANT as shown in the example below.
define('MY_CONSTANT', 'This is my information');
The advantage of these “define statements” is that text information can be included in your template files using a constant rather than a hardcoded value, allowing you to easily change templates but preserve your language customizations. It also facilitates making your store multi-language.
Examples and Usage
The definitions in english.php include the footer text, the sidebox headings, text used by the forms in Zen Cart and various error messages.
- From english.php
define('BOX_HEADING_CATEGORIES', 'Categories'); ... define('ENTRY_FIRST_NAME', 'First Name:'); ... define('ENTRY_STREET_ADDRESS_ERROR', 'Your Street Address must contain a minimum of ' . ENTRY_STREET_ADDRESS_MIN_LENGTH . ' characters.');
Page Specific Definitions
These definitions are exactly what the title says; They define text information for specific display pages in your cart.
The basic information in these files includes the text for the page heading and the text for the navbar. Depending on the page, you will also find information for e-mail messages and for the tasks carried out by a particular display page.
- From conditions.php
define('NAVBAR_TITLE', 'Conditions of Use'); define('HEADING_TITLE', 'Conditions of Use');
- From header.php
define('HEADER_ALT_TEXT', 'Powered by Zen Cart :: The Art of E-Commerce');
define('HEADER_SALES_TEXT', 'TagLine Here'); define('HEADER_LOGO_WIDTH', '192px'); define('HEADER_LOGO_HEIGHT', '64px'); define('HEADER_LOGO_IMAGE', 'logo.gif');</span>
- From contact_us.php
define('ENTRY_NAME', 'Full Name:'); define('ENTRY_EMAIL', 'Email Address:'); define('ENTRY_ENQUIRY', 'Message:');
Your Own Definitions
As you customize your cart, you may find that you need to include additional definitions. You can do this by creating a definition file (say,
yourdefinitionfile.php) and saving it to
includes/languages/ENGLISH/extra_definitionsConstructing your own defines would follow the pattern shown above.
- From product_free_shipping.php
define('TEXT_PRODUCT_FREE_SHIPPING_ICON', zen_image(DIR_WS_TEMPLATE_IMAGES . 'always-free-shipping.gif', 'Always Free Shipping')); // for an image or comment out to use another
These pages include your privacy statement, your conditions of use and shipping and handling information.
These files can be edited in a text editor and uploaded to your server, or you can edit them in your admin control panel in the Define Pages Editor.
- Pages from this folder
define_privacy.php define_conditions.php define_shippinginfo.php