Switching templates

Changing configuration values when template changes

Note: Users of Zen Cart 2.0.0 and above have access to the even more powerful template settings file feature.

The process of changing templates can be done using the Template Selection screen under Admin > Tools.

But what if the templates you are switching between expect different configuration values? It’s tedious to do these by hand, especially if you’re switching back and forth doing tests.

That’s why Zen Cart 1.5.8a introduced a new feature called Template Init. Here’s how it works:

  • Place a file called template_init.php in the includes/templates/YOURTEMPLATE folder.
  • The file will run when the template is set to YOURTEMPLATE from Admin > Tools > Template Selection.

Note this feature is not available when using Private Template Testing.

For example, here’s a template_init.php file that turns off CSS buttons when this template is selected:

// Settings for Older Template
$db->Execute("UPDATE " . TABLE_CONFIGURATION . " SET configuration_value='No' WHERE configuration_key = 'IMAGE_USE_CSS_BUTTONS'");

A corresponding query should exist in template_init.php of the other template(s) to restore the value when switching back:

// Settings for Newer Template(s)
$db->Execute("UPDATE " . TABLE_CONFIGURATION . " SET configuration_value='Yes' WHERE configuration_key = 'IMAGE_USE_CSS_BUTTONS'");

Any configuration variable can be set in the same way.

If you can’t recall the name of a particular variable, remember you can look it up on the All Configuration Settings page.

If you are using an older Zen Cart version and want this feature, you can merge this PR into your copy of admin/template_select.php.

This capability makes it easy to switch back and forth between the Bootstrap and Responsive Classic templates.

Create includes/templates/bootstrap/template_init.php as follows:

// Settings for Bootstrap
$db->Execute("UPDATE " . TABLE_CONFIGURATION . " SET configuration_value='0' WHERE configuration_key = 'PRODUCT_LISTING_COLUMNS_PER_ROW'");

Then create includes/templates/responsive_classic/template_init.php as follows:

// Settings for Responsive Classic
$db->Execute("UPDATE " . TABLE_CONFIGURATION . " SET configuration_value='1' WHERE configuration_key = 'PRODUCT_LISTING_COLUMNS_PER_ROW'");

Now switching to Bootstrap will make your product listing pages display in fluid mode, and switching to Responsive Classic will make your product listing pages display in rows mode, without you having to remember to make admin changes.

Still have questions? Use the Search box in the upper right, or try the full list of FAQs. If you can't find it there, head over to the Zen Cart support forum and ask there in the appropriate subforum. In your post, please include your Zen Cart and PHP versions, and a link to your site.

Is there an error or omission on this page? Please post to General Questions on the support forum. Or, if you'd like to open a pull request, just review the guidelines and get started. You can even PR right here.
Last modified February 25, 2024 by Scott Wilson (2788298).