Shopping cart software Wordpress Responsive Design Dreamweaver CSS Generic Version Developer License Updaters Store Tools Shopping Cart Mobile

Call sales now USA sales 1-718-887-7598 UK sales 0141 416 3414
Find us on FacebookFollow us on TwitterJoin us on LinkedinView ECT YouTube channelEcommerce Templates Google Plus
Connect with us on:
Home | Overview | Features | Buy Now | Live Stores | Support | Affiliates | Testimonials | Downloads | News | Hosting | Demo Store | Contact

Ecommerce Templates > PHP Version Help > Parameters for the includes.php page

PHP Parameters

In the vsadmin folder there's a file called includes.php - this is where you can specify some important tweaks regarding mail, shipping, display etc.You can add any of the variables below to the page includes.php - the order of the list is not important but make sure there are no duplicates. Additions since the previous version (6.2) will appear in orange.

Please note that the parameters are all Case Sensitive.

WordPress users - please note the synatx is slightly different for the WordPress integration ie the parameters would be in the format $GLOBALS['useemailfriend']=TRUE;


Display options

Shipping / tax options

Admin tweaks

Payment options

Layout options

Email options

Customer login

Customer reviews

Image tweaks

Affiliate options

Discount options

Gift certificates

Gift registry / wish lists

Tabbed panels


Email options

Email a friend

You can add the option of emailing a friend from your product detail page - this adds a link to a pop-up window with a form that you can fill out to forward the information regarding a product to a friend. If you wish to use this feature set the parameter like this $useemailfriend=TRUE;
if you would like to disable the feature then you need
$useemailfriend=FALSE;

HTML email

Emails can be sent in HTML format if you wish by adding the following switch
$htmlemails=TRUE;

Email orders

If you need to set email orders as Authorized in your admin orders page, set
$emailorderstatus=3;
Please note that if you use a value less than 3 then the orders are not authorized your cart will not clear after purchase.

IMPORTANT NOTE
An order status below 3 is not considered "completed". If this isn't what is needed, then it is better to make a new order status like "Received email order" and assign the emailorderstatus to that new status id. That way the order will be "completed".

Order status email always on

Using the setting
$alwaysemailstatus=true;
will mean that the checkbox for "email order status change" is always set by default.

Custom headers

You can set the parameter $customheaders in your vsadmin/includes.php file for hosts that require non-standard email headers. Instances of %from% will be replaced by the "From:" address and instances of "%to%" (not normally needed) will be replaced by the "To:" address. For example . . .
$customheaders = "MIME-Version: 1.0\nFrom: %from%\nContent-type: text/plain; charset=iso-8859-1\n";

Collect email addresses

Customers are asked on checkout if they would be willing to receive promotional emails and if so their email is added to the database for you to use with your mailshots.
If the following is set in the vsadmin/includes.php file then by default the box will be checked.

$allowemaildefaulton=TRUE;

Remove mailing list checkbox

Set this in vsadmin/includes.php

$nomailinglist=TRUE;

to remove the mailing list checkbox.

Stop email confirmation for mailing list

Setting this in vsadmin/includes.php

$noconfirmationemail=TRUE;

will stop the email a customer receives to verify their mailing list sign-up. By default the customer will receive an email to verify their address and intention.

Ask a question (Minimum version 6.1.0)

If you want your customers to be able to mail you directly about a product on the detail page, set the following

$useaskaquestion=TRUE;

If you would like that to appear in a lightbox window rather than a pop-up, add

$inlinepopups=TRUE;

Show store name in email responses (Minimum version 6.2.4)

To set the store name used in email responses so your customers see this for instance...
Your Store Name <you@yourstore.com> use

$emailfromname="Your Store Name";

Back to top

Layout options

Product listings (Minimum version 1.3.7 - Maximum Version 5.9.4)

Note
The sortBy parameters were moved to the admin main settings page in Version 6 but if you still need to set the product listing through the includes file you can use the $orsortby parameter. This is handy if you want to use them on static pages with a different listing. So if you want to sort the product listing alphabetically use $orsortby=1; Please note this setting also overrides the listing choices in the new product filter bar.

  1. = sorting the products alphabetically
  2. = sorting the products by id
  3. = sorting the products by price (cheapest first)
  4. = sorting the products by price (most expensive first)

So for example if you wanted to list your products alphabetically you would choose this option:
$orsortby = 1;
or by product id like this
$orsortby = 2;

$orsortby=5;
This will sort the products by the order the products are within the database. This is particularly useful where the sort order is not important and will result in the fastest way of displaying products.

$orsortby=6;
This will sort the products in ascending order depending on the value added to the "Product Order" box in the product admin page.

$orsortby=7;
This will sort the products in descending order depending on the value added to the "Product Order" box in the product admin page.

$orsortby=8;
This will sort the products in ascending order depending on the date added.

$orsortby=9;
This will sort the products in descending order depending on the date added.

Product layout options

In version 1.3.7 we have added the possibility for different layout formats for your products.

$productcolumns=2;

$useproductbodyformat=1;

$usesearchbodyformat=1;

$usedetailbodyformat=1;

$usecategoryformat=1;

$allproductsimage="";

Those who are upgrading from previous versions will need to add these parameters..

By setting useproductbody format to 2 like this
$useproductbodyformat=2;
the products are displayed with the product options, price and buy button below the product image. When useproductbodyformat is set to 1 the product options, price and buy button are displayed to the right of the product image.

The reason we added this second layout is that it lends itself well to having more than one column of products. So, when using
$useproductbodyformat=2;
the products will be displayed in the number of columns specified by productcolumns, such as

$productcolumns=2;

You can have as many as you like in theory, but just make sure they fit on your page.

Please note that with the useproductbodyformat set to 1 the productcolumns setting will be ignored.

To allow you to specify the search results independently of the general product display, you can set usesearchbodyformat to 1 or 2 in the same way.

There is also a second product detail format available now. Setting
$usedetailbodyformat=2;

will display the product detail page with the image to the left of the product description, price, quantity and buy button.

If you need the category text and description to the right of the image choose $usecategoryformat=2;

$usecategoryformat=3;
will show the image on top of the category name on top of the category description

$allproductsimage="";
allows you to specify an image for "All Products" and the path can be inserted here.

$useproductbodyformat=3;
This will be a "list" like layout, and you will be able to select the columns you wish to display by setting and customizing . . .
$cpdcolumns="id,image,name,description,discounts,listprice,price,priceinctax,instock,options,quantity,buy";
. . . and the column headers like for instance . . .
$cpdheaders="ID,Name,description,discounts,listprice,price,Inc. Tax,In Stock,Options,Quant, ";

For more information on the category, product and product detail display, please visit our layouts page.

$usedetailbodyformat=3;
...if you need a product detail layout similar to 2 but with the product description below the rest of the content.

Continue shopping

$actionaftercart=1;

...or not setting anything will mean that the continue shopping button will take the URL from the xxHomeURL from the vsadmin/inc/languagefile.php which is the current default.

$actionaftercart=2;

...will make the cart "continue shopping" button return to the page you just came from when you are on the cart contents page.

$actionaftercart=3;

...when you add something to your cart, you will refresh immediately back to the products page you came from without going to the cart contents page.

$actionaftercart=4;

...will skip the page showing "The products have been added to your cart" when adding products to the cart.

$cartrefreshseconds=2;

... can be used to control the number of seconds that the message "The items has been added to your cart" is shown. If set to zero this will perform an HTTP redirect rather than a refresh.

If you need to change the continue shopping link on thanks.php, use the following

$thankspagecontinue="http://www.yourstoreurl.com/finishpage.php";

Category layout

$categorycolumns=1; - will give you a vertical list of categories in a single list

$categorycolumns=2; - will show the categories in two columns

$categorycolumns=3; - will show the categories in three columns

$catseparator=""; - is required to use the new category set up - no changes are necessary here

$sortcategoriesalphabetically=TRUE; - will sort your categories alphabetically

Dynamic menu

You can limit the number of "popout levels" that the dynamic menus pop out to by setting the parameter
$menupoplimit=2;
. . . where 2 in this example would limit to 2 popout levels.

Product separation

You can remove the horizontal line (and the space it takes up) between products with the addition of

$noproductseparator=TRUE;

If you want to add a custom separation between products then use this

$prodseparator="<p align=\"center\">........</p>";

Product detail static page

You can set the character of your choice that is used between the individual words of the product name which make up the product detail static page. For example if you want to separate the words with a hyphen then set
$urlfillerchar='-';
...to get a page name like this product-name.php

Show thumbnail image in the shopping cart

If you want to show a thumbnail image in the cart of the product a customer has purchased, add this to vsadmin/includes.php
$useimageincart=TRUE;

Link the thumbnail image in the shopping cart

If you want to link the thumbnail image in the cart to its product detail page, add this to vsadmin/includes.php
$linkcartproducts=TRUE;

Multi-purchase columns

If you are using the multi purchase feature, you can specify the number of columns for the quantity boxes with the following setting

$multipurchasecolumns=3;

Change manufacturers page name

If you need to change the name of manufacturers.php, use the following

$manufacturerpageurl='brands.php';

Accessibility & validation

Version 5.6.0 saw a lot of changes to move the code to XHTML 1.0 Transitional and Section 508 (accessibility) compliance. This meant removing a very small amount of formatting from previous versions. To take advantage if this new feature you will need to add the following to vsadmin/includes.php

$nomarkup=TRUE;

Any formatting that changed can be replaced through the css file. For example these will have no formatting but can be replaced with the following addition to the css file

div.proddiscounts{
color: #FF0000;
font-size: 11px;
}

div.prodid{
font-weight: bold;
}

div.prodname{
font-weight: bold;
}

span.prodoption{
font-weight: bold;
}

List categories alphabetically

You can list categories alphabetically on the store with the following

$sortcategoriesalphabetically=TRUE;

Enable recently viewed items

To enable the recently viewed items feature, set the following

$recentlyviewed=TRUE;

To limit the number of recently viewed items in the list...

$numrecentlyviewed=5;

Setting the category root (Minimum version 5.9.0)

To display root categories in the css menus, set the following

$menucategoriesatroot=TRUE;

Limit menu levels (Minimum version 5.9.0)

To limit the number of pop-out or drop-down levels, set the following

$menupoplimit=2;

. . . where 2 in this example would limit the hierarchy to 2 levels.

Banded prices in product filter bar (Minimum version 6.0.0)

To change the banded price thresholds in the product filter bar, set the following

$filterpricebands=150;

. . . where 150 is the banded threshold value.

To change the default sort text labels in the product filter bar, you can use the following

$sortoption1='Sort Alphabetically';
$sortoption2='Sort by Product ID';
$sortoption3='Sort Price (Asc.)';
$sortoption4='Sort Price (Desc.)';
$sortoption5='Database Order';
$sortoption6='Product Order';
$sortoption7='Product Order (Desc.)';
$sortoption8='Date Added (Asc.)';
$sortoption9='Date Added (Des.)';
$sortoption10='Sort by Manufacturer';

CSS layouts for the category, product and detail pages (Minimum version 6.2.0)

To use the css based layouts for the category, product and detail pages, set the following

$usecsslayout=TRUE;

If you want to be able to order the elements on the product detail page, add the following to vsadmin/includes.php, setting the order of your choice...

$detailpagelayout='navigation,checkoutbutton,productimage,productid,manufacturer,sku,productname,discounts, instock,description,listprice,price,quantity,currency,options,addtocart,previousnext,emailfriend,reviews';

In version 6.3 we added a couple more parameters to be used with the css layouts

shortdescription - this will show the short description on the detail page
custom1,custom2,custom3 - these will show show the custom fields available in the product admin page on the detail page. You will need to add these to your includes.php for the custom fields to appear at the bottom of the product admin page.

If you want to give titles to the custom fields add the following

$detailcustomlabel1="Custom Title 1 ";
$detailcustomlabel2="Custom Title 2 ";
$detailcustomlabel3="Custom Title 3 ";

More information can be found on our css layouts help page.

Product columns for the mobile layout (Minimum version 6.2.0)

If you need to set the number of product columns on the products pages just for mobile users and without interfering with your main site use the following

$mobilebrowsercolumns=1;

...where 1 is the number of columns you want to show on the mobile side. NOTE: This will be ignored if you are using the parameter above ($usecsslayout=TRUE;)

Product name in dynamic product detail page URL (Minimum version 6.2.4)

To use the product name for dynamic product detail page links instead of the product id. To do this add the parameter...

$usepnamefordetaillinks=TRUE;

When using this parameter you can set an optional replacement character for spaces. For instance if you set...

$detlinkspacechar="-";

Then the product name "My Test Product" would result in "My-Test-Product"

When using this system, all product names must be unique or it will be impossible to view some of your products. Also, when using the optional space replacement character, you cannot then use that character in product names as again it will make it impossible to find those products in the database.

Remove soft cart feature (Minimum version 6.3)

If you prefer not to use the pop up soft cart feature and continue to use the traditional cart, set the following

$usehardaddtocart=TRUE;

Please note this is the default for mobile devices where the pop up may not display correctly in smaller browser windows.

Show product name within <h1> tags on the product detail page (Minimum version 6.3)

You can choose to have the product name on the detail pages within <h1> tags. To do this add the following to vsadmin/includes.php

$detailnameh1=TRUE;

Change the position of the zip / post code field on checkout (Minimum version 6.3.2)

You can change the position of the Zip / Postal Code field in the customer details portion of checkout to allow for some European countries where the zip commonly comes before other address elements. Choose from one of the following.

$zipposition=1; // (Default) Places the Zip above the Phone Number
$zipposition=2; // Places the Zip above the Country Selector
$zipposition=3; // Places the Zip above the State Selector
$zipposition=4; // Places the Zip above the City entry box.

Back to top

Payment options

Setting the path to your SSL

If you are using a payment provider that requires SSL then what the system is going to look by default is your website URL on an HTTPS connection, ie https://www.yoursite.com/cart.php
If you have shared ssl space which requires a different url, or if you want to override the switch to SSL for testing purposes then you can override it like this:

$pathtossl = "https://www.yourhostssl.com/yourdir/";
. . . or . . .
$pathtossl = "http://www.yoursite.com/";
. . . to keep it on http and not go to https

Disabling SSL

Setting $nochecksslserver=TRUE;
will disable the checking with capture card and other payment systems that require an SSL server that check you are on an SSL connection.

IMPORTANT NOTE:
This should not be set unless you are most certainly sure that you are on HTTPS when viewing the credit card details. Our check for SSL can be fooled the way some servers set up their shared SSL certs so all this switch does is remove the warning in this case. It should NOT be used to enable yourself to view CC details on a non-SSL connection.

Encryption method

For those using Capture Card, the encryption method "mcrypt". You can set this by adding...

$encryptmethod="mcrypt";

It does require the mcrypt library 2.4 or above to be compiled with PHP so ask your host. You also need to set a "pass phrase" in the vsadmin/includes.php file. For instance...

$ccencryptkey = "adhdhdhe3sk39 add your own random text here and do not copy this";

Do make it unique (don't just copy the example above). Do add random text (not the random text above). Do make it at least 32 characters long (and not using the text above).

Please note that if someone manages to compromise your database AND your site so they gain access to your secret phrase, then it is possible that they can decrypt the credit card numbers. It is not a public / private key type algorithm. However it does add an important extra level of security.

You can also set the encryption cypher used by setting for instance...
$mcryptalg = MCRYPT_RIJNDAEL_128;
...in your includes.php page. A list of cyphers supported in PHP is available here...
http://www.php.net/manual/en/ref.mcrypt.php

Force form submission

For payment processors where the credit card details are taken on an SSL connection on your site you can set the parameter:

$forcesubmit=TRUE;

...which will submit the form by default in 5 seconds. If you want to change that 5 second interval you can set

$forcesubmittimeout=5000;

where the time is set in milliseconds, so the above example would result in a 5 second delay.

Authorize.net

Add the parameter $secretword to encrypt your authorize.net merchant id and transaction key in the database for extra security. For example...
$secretword="this is my secret word";
Please note that if you set this, you will have to reset your merchant id and transaction key in your admin payment providers page for authorize.net

If you are using the authorize.net AIM system you can now set the parameter
$acceptecheck=true;
to allow for eChecks. You will need to have your authorize.net account set up for accepting eChecks.

Authorize.net AIM method can now be used with the WellsFargo SecureSource system using the setting
$wellsfargo=true;

Authorize.net time adjust

Setting $authnetadjust will adjust the authorize.net timestamp by the given number of seconds. For instance . . .
$authnetadjust=1320;

Force CVV credit card code on checkout

For payment processors that are integrated into your own site, you can set
$requirecvv=TRUE;
. . . to force the customer to enter their CVV credit card code on checkout.

Force the checkout to use 2Checkout's v2 system

Setting...
$use2checkoutv2=TRUE;
. . . in your vsadmin/includes.php file will force the checkout to use 2Checkout's v2 system.

Use 2Checkout's one page checkout

Set...

$use2checkoutfastcheckout=TRUE;

. . . in your vsadmin/includes.php file to use the 2Checkout one page checkout.

Force the PayPal locale

To force the PayPal payment page locale to one of your choosing you could set...
$paypallc="FR";
...to force the default language / locale to French.

Force customers to select from the list of payment methods

To force customers to select from the list of payment methods rather than having the first one selected by default add...

$nodefaultpayprovider=TRUE;

Show available payment methods with radio buttons

If you want to show the available payment methods on checkout with a radio buttons vertically use...

$payproviderradios=1;

... to show them with radio buttons horizontally use...

$payproviderradios=2;

Add Google Analytics ecommerce code

If you want to track orders using Google Analytics add the following...

$googleanalyticsinfo=TRUE;
$usegoogleasync=TRUE;

... then open your php pages and just above the closing </body> tag add the following...

<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-XXXXX-X']);
_gaq.push(['_trackPageview']);
<?php print @$googleanalyticstrackorderinfo?>(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(ga, s);})();
</script>

If you want use Google Analytics Universal Code you will need to be running Version 6.3 and add the following to vsadmin/includes.php

$usegoogleuniversal=TRUE;

You will also need this code on thanks.php

<script type="text/javascript">
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create','UA-XXXX-Y','auto');
ga('send','pageview');
ga('require','ecommerce','ecommerce.js');
<?php print @$googleanalyticstrackorderinfo?>
</script>

Verified by Visa / Cardinal Commerce (Minimum version 5.9.4)

If you are using Verified by Visa / Cardinal Commerce, you will need the following in vsadmin/includes.php...

$cardinalurl="https://centinel400.cardinalcommerce.com/maps/txns.asp";

Persist in cart (Minimum version 6.0.0)

To specify how long cart items stay in the cart for non-logged in customers, you will need the following in vsadmin/includes.php...

$persistentcart=5;

... where 5 is the number of days the item will remain.

Payment provider extra parameter (Minimum version 6.1.4)

If you need to specify a particular parameter for a specific payment provider you will need the following in vsadmin/includes.php...

$payprovextraparams1='<input type="hidden" name="charset" value="UTF-8" />';

... where 1 is the id of the payment provider (PayPal in this example).

Gift wrapping charge (Minimum version 6.2)

If you need need to turn on the gift wrapping feature, you can set the cost of gift wrapping with the following in vsadmin/includes.php...

$giftwrappingcost=0.8;

PayPal IPN (Minimum version 6.2)

If you receive a message "No IPN" and your host doesn't offer HTTPS support for cURL you will need the following in vsadmin/includes.php...

$usefsockforpaypalipn=TRUE;

No price anywhere on the store (Minimum version 6.3.4)

If you need to completely strip prices from the product listings and shopping cart for use in situations where quotes can be requested by ordering for instance, set...

$nopriceanywhere=TRUE;

Back to top

Shipping and tax options

Adding tax to shipping and / or handling

If you need to add tax to shipping you'll need to choose
$taxShipping=1;
if not leave it as it is:
$taxShipping=0;

Setting $taxShipping=2;
will add the shipping tax to the state and country tax totals.

If you need to add tax to handling you'll need to choose
$taxHandling=1;
if not leave it as it is:
$taxHandling=0;

Setting $taxHandling=2;
will add the handling tax to the state and country tax totals.

Add a handling charge which is a percentage of the cart total + shipping + handling. For instance you could set .
$handlingchargepercent=5;

Removing the shipping address

Use:

$noshipaddress=TRUE;

to cause a shipping address entry section not to be shown on the checkout page if set.

"Will pick up option"

Use:

$willpickuptext="Will Pickup";

If you want to allow your customers the option of picking up their purchase from your physical location. The text here can be changed as necessary.

Use

$willpickupcost=1.32;

To set the cost of picking up from your location. Set to zero if there is no charge.

On Canadian based stores the home state tax rate will need to be set as well with the parameter...

$homestatetaxrate=8;

...where 8 is the percentage of the local province tax rate.

To remove the handling charge (Minimum version 6.1.4) for Will Pick Up orders use

$willpickupnohandling=TRUE;

Show tax inclusive prices

To show tax exclusive price followed by the inclusive price on the products page use
$showtaxinclusive=1;
the wording for the tax can be changed in vsadmin/inc/languagefile_en.php.

From version 5.4 to only show tax inclusive price, set

$showtaxinclusive=2;

From version 6.3 if the tax is already assumed to be included in the product price, set

$showtaxinclusive=3;

UPS Options

The way that you deliver your packages to UPS for delivery can affect the total cost of delivering the package. We have set the default as "Customer Counter", though you can change this by setting the following in your vsadmin/includes.php file . . .

$upspickuptype="03";

The code in quotes there would be taken from the following table...

01 - Daily Pickup
03 - Customer Counter
06 - One Time Pickup
07 - On Call Air
19 - Letter Center
20 - Air Service Center

Remember to enclose the code above in double quotes. Also, please note that these options are not exactly the same as you might find on the UPS web site but we hear that is something that UPS are working on...more information

The signature options available for UPS are...
$signatureoption="direct";
$signatureoption="indirect";
$signatureoption="adult";

To add UPS shipping insurance based on the product value, but not ask the customer...
$addshippinginsurance=1;

To ask the customer if they would like shipping insurance on the checkout form...
$addshippinginsurance=2;

Commercial location

Set the following in vsadmin/includes.php ...

$commercialloc=TRUE;

...if you want to place a question and checkbox on checkout for shipping to a commercial location. This is automatically set for UPS but can be used for other shipping methods.

In version 6.2 you can set the following

$commercialloc=2;

if you want the default set to "on" instead of defaulting to "off". That will still give the customer the opportunity to set it to residential, and will not set to commercial if on a previous order they set residential.

Shipping insurance

Shipping insurance can now be added to more shipping types than just UPS shipping. If using UPS shipping, then adding

$addshippinginsurance=1;

to your includes.php file will calculate shipping costs with insurance. If using UPS shipping then add

$addshippinginsurance=2;

will ask the user if they would like shipping insurance, and if so add it to the shipping cost.

With shipping types other than UPS, you have to also set an amount, shipinsuranceamt
for instance...
$shipinsuranceamt=5;
If $addshippinginsurance=1; then in this example 5% of the product price total will be added to the shipping cost for insurance.
If $addshippinginsurance=2; then in this example 5% of the product price total will be added to the shipping cost for insurance IF the user checks the "yes I want shipping insurance" box on checkout.
If $addshippinginsurance=-1; then in this example 5.00 (of your monetary units, say Dollars) will be added to the shipping cost for insurance.
If $addshippinginsurance=-2; then in this example 5.00 (of your monetary units, say Dollars) will be added to the shipping cost for insurance IF the user checks the "yes I want shipping insurance" box on checkout.

For Canada Post you have to set insurance in your Canada Post shipping profile.

For USPS add the following

$useuspsinsurancerates=TRUE;

in conjunction with $addshippinginsurance=1; or $addshippinginsurance=2; from above.

Invoices / packing slips

$invoiceheader='<img src="images/logo.gif" border="0"><br><br>';

...this will print your logo at the top of the invoice. Obviously you will need to upload the logo to your images folder and set the path / name correctly.

$invoiceaddress='<br><b>My Company LLC</b><br>10, My Road<br>My Town, MyCity 90210<br>USA<br><br>';

... this will print your address on the invoice. As you can see it is possible to use HTML for formatting.

$invoicefooter='<br><br><font size="1">Thank you for shopping with EcommerceTemplates.com</font>';

..will print the footer information you need to include. Again HTML can be used for formatting.

Packing slip headers and footers

These settings are available for packing slips, mirroring the invoice versions to provide separate headers for the packing slip. HTML can be used as in the invoice examples above.

$packingslipaddress="packing slip address";
$packingslipheader="packing slip header";
$packingslipfooter="packing slip footer";

Packing slip list order (Minimum version 6.0.4)

If you need to sort the items on the packing list by the product id or product name, use the following in includes.php...

$packingslipsort="cartProdId";
$packingslipsort="cartProdName";

These parameters were added in Version 6.1.4 to allow for sorting of the products in an order along with the invoice and packing slip

$viewordersort="cartprodid";
$packingslipsort="cartprodid DESC";
$invoicesort="cartprodname";

Canadian Tax

Support for the Canadian PST / GST / HST tax system, including the Price Edward Island and Quebec systems of adding the provincial tax to the product total + government tax. This feature is automatically set when you choose Canada in the main admin settings of the control panel.

Split heavy packages

Adding the parameter $splitpackat when using UPS or USPS shipping will split heavy packages into multiple packages. For instance...
$splitpackat=70;

Split large packages

By default large packages are split so a rate will be returned. If you need to turn off that feature, you will need the following...

$nosplitlargepacks=TRUE;

Canada Post

To place Canada Post in test mode on the testing server, please use the following parameter
$canadaposttest=TRUE;

Per product tax rate

To set a tax rate per product add this and a tax rate box will appear in the product admin page...
$perproducttaxrate=TRUE;

Shipping estimator

To place a shipping estimator on the cart page before checkout use
$estimateshipping=TRUE;
There is also this parameter you can set if you are using a shipping method like weight based or price based shipping where the ship state is necessary . . .
$defaultshipstate="California";
Please note, this is not necessary for UPS / USPS / Canada Post shipping as it is the zip / postal code that is used.

This switch is available to not set a default zip (postal) code for the shipping estimator . .
$nodefaultzip=TRUE;

Radio buttons to replace drop down choices

If you would like to present the available shipping options as radio buttons rather than the default drop down choices then set the following . . .

$shippingoptionsasradios=TRUE;

Combine shipping and handling

Shipping and handling can be combined with the switch . . .
$combineshippinghandling=TRUE;

Default shipping tracking

This allows selection of the default shipping carrier on the tracking page. The choices are "ups", "usps" and "fedex". For instance...
$defaulttrackingcarrier="usps";

If you need to offer a choice of carriers for tracking, add the following

$trackingcarriers="ups,usps,fedex";

Removing FedEx discounted rates

If you receive discount rates from FedEx, this setting will give the customer the full default rate
$uselistshippingrates=TRUE;

FedEx delivery options

These services are available for FedEx shipping
$saturdaydelivery=true;
Presents customer with Saturday Delivery option
$packaging="25kgbox";
envelope, pak, box, tube, 10kgbox, 25kgbox
$codpaymentprovider=4;
Declares which payment option is used for Cash On Delivery
$signatureoption="none";
none indirect direct adult
$allowsignaturerelease=TRUE;
Allows customer to select Signature Release as an option
$insidepickup=TRUE;
Calculates rates based on an inside pickup (freight only)

NOTE
The C.O.D. / Saturday Delivery / Signature (direct, adult) / Packaging switches will also work with UPS.

FedEx SmartPost (Minimum version 6.1.0)

These are the parameters associated with FedEx SmartPost

$smartpostindicia="PRESORTED_BOUND_PRINTED_MATTER";
more options: MEDIA_MAIL PRESORTED_STANDARD PARCEL_SELECT PRESORTED_BOUND_PRINTED_MATTER
$smartposthubid="5531";
$smartpostancendorsement="CARRIER_LEAVE_IF_NO_RESPONSE";
more options: CHANGE_SERVICE ADDRESS_CORRECTION RETURN_SERVICE

USPS container types

If you need to specify container types for USPS shipping then you'll need the following addition

$uspsprioritycontainer="flat rate box";

available options for priorirty mail: flat rate envelope / flat rate box / lg flat rate box

$uspsexpresscontainer="flat rate envelope";

To make the system use whatever flat rate box fits rather than having to specify container types explicitly, use the following...(Version 5.8 minimum)

$uspsprioritycontainer="auto";
$uspsexpresscontainer="auto";

Use domestic shipping

If you need to force the USA and Canada to both use the "domestic" shipping method rather than the international shipping method you have setup in admin, set the following

$usandcausedomesticservice=TRUE;

Automatically copy the billing address to the shipping address.

If you want to automatically copy the billing address to the shipping address if a shipping address is not entered, set the following

$autobillingtoshipping=TRUE;

Optionally hide the shipping portion of the address on checkout. (retired in Version 6.3)

If you want to optionally hide the shipping portion of the address on checkout unless the customer clicks to say it is different from the billing address, set the following

$hideshipaddress=TRUE;

Force the state selector in the shipping estimator. (Minimum version 5.9.0)

If you want to force the state selector in the shipping estimator, set the following

$forcestateselector=TRUE;

Set the initial box weight. (Minimum version 6.0.3)

If you want to set the initial weight of your shipping box / packaging, set the following

$initialpackweight=2.5;

Show USA States and Canadian Provinces for use in the admin zones page. (Minimum version 6.2.0)

If you want to need to set State / Province zones for both countries when using weight or price based shipping, set the following

$usandcasplitzones=TRUE;

Discount online shipping rates. (Minimum version 6.3)

If you want to set percentage discounts / increments per shipping carrier use the parameters...

$discountshippingups=-10;
$discountshippingusps=5;
$discountshippingfedex=20;

...where -10 will discount the online shipping rate by 10% and 5 will increment the online shipping rate by 5%.

Back to top

Display options

Product page display numbers

To display the product page number links at the top of the page as well as the bottom set
$pagebarattop=1;

Removing buy and checkout buttons

You can simply eliminate the buy and checkout buttons as well as the price for all products, this is done by choosing
$nobuyorcheckout=TRUE;
and
$noprice=TRUE
;

Remove top navigation

If you need to remove the top navigation ie. home >> category >> product then set
$showcategories=FALSE;

Terms and Conditions

If you need to make your customers agree to your terms and conditions on checkout, set $termsandconditions=TRUE;
You will also need to create a page with your terms and conditions called termsandconditions.php ... which will be shown in a 420 x 380 popup.

Quantity boxes

Setting the following to TRUE will put up a quantity box on the products and the product details page (not available if using usedetailbodyformat=2):

$showquantonproduct=FALSE;
$showquantondetail=FALSE;

Add clickable buttons to Quantity boxes (Minimum version 6.2.4)

To use clickable graphics to raise / lower the quantity of a product to add to cart add this parameter to the vsadmin/includes.php file...

$quantityupdown=TRUE;

Graphics for the up / down buttons are available in the updater images folder.

Zero price

If you set this, for instance...

$pricezeromessage="<b>Price: Please call</b>";

...then in the case where a price is set to zero, this message will be printed instead. If the pricezeromessage is not set then products with a zero price will be displayed as Price: $0.00 as usual.

Show product id

$showproductid=TRUE;

...will cause the product id to display on the product pages. The text "Product ID" is from the vsadmin/inc/languagefile.php as xxPrId

Hide product options

$noproductoptions=TRUE;

...this will hide all the product options on the products page.

Extra checkout fields

It is possible to add two new fields to your cart checkout page. The extraorderfield1 will go at the top of the billing and shipping form and the extraordefield2 at the bottom of the billing and shipping form.

$extraorderfield1="Company Name"; - adds a company name field to the top of your cart checkout page, text can be edited here for other uses.

$extraorderfield1required=TRUE; - will make this field obligatory, setting to false will make it optional

$extraorderfield2="Another Field"; - will add an additional field to the bottom of the cart checkout page, obviously the text will need editing here.

$extraorderfield2required=TRUE; - will make this field obligatory, setting to false will make it optional

There are 2 other "checkout" parameters which will appear in the "Miscellaneous" section, following the additional information field. You can use these in the following way...

$extracheckoutfield1="Checkout Field";
$extracheckoutfield2="2nd Checkout Field";

To make these required use...

$extracheckoutfield1required=TRUE;

There is also a parameter to switch the control and the text which can be useful if you are using a checkbox or similar small control. To do that just add...

$extracheckoutfield1reverse=TRUE;

To specify custom HTML for these just use something like this for example...

$extracheckoutfield1html="<input type=\"checkbox\" name=\"ectfield\" value=\"Yes\">";

$extracheckoutfield1html="<select name=\"ectfield\" size=\"1\"><option value=\"No\">No</option><option value=\"Yes\">Yes</option></select>";

Extra address line on checkout

To enable the use of an "Address Line 2" entry on the checkout form, use the following switch...
$useaddressline2=TRUE;

Forcing minimum purchase amount

Setting the parameter $minpurchaseamount will force a minimum purchase amount. You can also set the parameter $minpurchasemessage to display a message / html if the minimum purchase amount is not met. For instance...
$minpurchaseamount=4.99;
$minpurchasemessage="I'm sorry, we have a minimum purchase amount of £4.99. Please go back and <b>buy some more</b>";

Alternative currency format

You can now have total control over the display of the currency conversions if you require. For instance use the following. . .

$currFormat1="<strong>€</strong>%s";
$currFormat2="<strong>£</strong>%s";
$currFormat3="<strong>\$</strong>%s";

In each of these %s is replaced by the actual currency value. Be careful that the symbols match the currencies you have chosen on your admin main page. Of course you can place any formatting or text here.

NOTE
The dollar sign is a special character in PHP so would need to be escaped as in the example above, \$

Product detail link

Instead of having the product “details” link leading to the proddetail.php page, you can specify your own link by adding the following (for example) to your vsadmin/includes.php file.

$detailslink="<a href=\"%largeimage%\" target=\"_blank\">";
$detailsendlink="</a>";

Any instances of %pid% will be replaced by the product id and any instances of %largeimage% will be replaced by the the value of you have set for large image in your admin products page. This will allow you to vary the links per product.

Hide product option price difference

By setting the switch . . .
$hideoptpricediffs=true;
. . . you can hide the price difference in the product option drop down menus and the checkout page. Only the total price will be shown.

Remove category id from Product Detail page

Set the following switch . . .
$nocatid=TRUE;
if you don't want the category id added to the product detail page links . . .

Showing stock totals / out of stock products on the products page

Set the following switch . . .
$showinstock=TRUE;
to show the number of items in stock on your products page

Use
$noshowoutofstock=TRUE;
if you don't want out of stock items to appear on your products page

Cross selling

This addition will show the cross selling features you want to display below the cart:

$crosssellaction='recommended,related,alsobought,bestsellers';

These options are also used depending on what information you would like to display there

$csnobuyorcheckout=TRUE;
...will remove the buy and checkout buttons
$csnoproductoptions=TRUE;
...will remove the product options
$csnoshowdiscounts=TRUE;
...will remove the discounts text

If you want to change the text that introduces the cross selling features then add these to includes.php

$csrecommendedtitle='Your recommended title';
$csalsoboughttitle='Your also bought title';
$csrelatedtitle='Your related title';
$csbestsellerstitle='Your best seller title';

If you want to limit the number of products that are shown then you can add this to includes.php

$crosssellcolumns=2;
$crosssellrows=1;

This will give you two columns and 1 row of products, effectively a maximum of 2 products showing.

If you want to limit the best seller date range to a specific number of days, use the following

$bestsellerlimit=180;

... where 180 is the number of days in the range (Version 6.2.1 minimum)

Full set up details can be found on the cross selling help page.

Force product detail link

Adding....

$forcedetailslink=TRUE;

...to includes.php will force a link to the corresponding product detail page even if there is no long description added through the product admin page.

Setting the limit of text in the short product description

If you want to limit the number of characters used on the products page for the product description then use this setting...

$shortdescriptionlimit=100;

...where 100 is the number of characters that will be shown on the products page. This means that you can use the same description in both the long and short descriptions but the short description will be truncated at that point.

Remove the "remember me" box from checkout

If you want to remove the Remember Me feature from the checkout page then add this to vsadmin/includes.php...

$noremember=TRUE;

Show the SKU on the product and detail pages

If you want to show the SKU in the products and product detail pages then add this to vsadmin/includes.php...

$showproductsku="ISBN";

...you will need to add the SKU to the product admin page.

Show the manufacturers on the search page

To show a drop down and allow customers to refine the search by manufacturer, use this setting...

$searchbymanufacturer="Manufacturer";

...you will need to define the manufacturers in the manufacturer admin page and select them from the product admin page.

Show the manufacturers on the products page

To show the manufacturer field on the products page, add

$manufacturerfield="Manufacturer";

Remove options showing in cart using product alt id

For options with an alternate product id not to be added to the cart set the following...

$noaddalternateoptions=TRUE;

In Version 5.7.0 and onwards the option is no longer shown separately for the alt prod id feature but if you need that itemized, use the following.

$addalternateoptions=TRUE;

Remove the category name and / or description

This feature is particularly useful if you are using the dynamic title / meta description tag feature as you can remove the category name and / or the category description from the publicly viewable categories page whilst entering them in the category admin page so they can be used for the dynamic title / meta description tags.

To remove the category name you will need to set the following

$nocategoryname=TRUE;

To remove the category description

$nocategorydescription=TRUE;

Add buy button to the top of the product detail page

If you would like to add a buy button to the top of the product detail page so it also appears "above the fold", you will need this addition

$proddetailtopbuybutton=TRUE;

Split the first name and last name on checkout

If you would like to split the first name and last name on checkout add this

$usefirstlastname=TRUE;

Use the category name as a category identifier

If you would like to use the category name as a category identifier, which can be handy for search engine purposes add this

$usecategoryname=TRUE;

Remove the label next to the product options

If you would like to remove the label next to the product options, you would need this addition

$noselectoptionlabel=TRUE;

Remove the previous and next links on the product detail page

If you would like to remove the previous / next links on the product detail page, you would need this addition

$nopreviousnextlinks=TRUE;

Remove the category drop down choices from the search page

If you would like to remove the category drop down choices from the search page, add the following

$nocategorysearch=TRUE;

To do the same in the admin section...

$noadmincategorysearch=TRUE;

Use the long description for the meta description tag

If you prefer to use the long description rather than the short description for the meta description tag, add the following

$usemetalongdescription=TRUE;

Notify when back in stock (Minimum version 6.0.0)

To replace the Out of Stock message with a link to notify the customer when the product or option is back in stock, add the following...

$notifybackinstock=TRUE;

Please note that you will need to be using the stock management feature to use this.

Display the total price in product options (Minimum version 6.2.2)

If you prefer to show the full cost of the product depending on the option selected rather than the standard price difference, add the following...

$absoptionpricediffs=TRUE;

Remove default text from text input options (Minimum version 6.2.4)

The default text in text input options can be automatically removed when the user clicks the option. To use this feature you just need to add this parameter to your vsadmin/includes.php file..

$removedefaultoptiontext=TRUE;

MagicToolbox on products page (Minimum version 6.3)

The MagicToolbox features will appear on the product detail page but if you would also like to show them on the products.php page, set the following...

$magictoolboxproducts="MagicZoomPlus";

Change "magicZoomPlus" for the image effect you are using. A full set of parameters are available on our MagicToolbox help page.

Remove the additional information field on checkout (Minimum version 6.3)

If you want to remove the additional information field on checkout, add the following...

$noadditionalinfo=TRUE;

Back to top

Affiliate options

Affiliates cookie

By default the affiliate cookie stays active for 30 days, this means that if somebody clicks on an affiliate link and then comes back later to purchase as long as it's within 30 days, the sales will be accredited to the affiliate partner. If you need to change this then the value here
$expireaffiliate=30;
will have to be modified.

Affiliates commission

You can now set an affiliate percentage in the affiliates admin, and set a
$defaultcommission=12;
to set a default commission for new affiliates

Back to top

Discount options

Remove discount / coupon feature

To remove the discount and coupon function choose
$nogiftcertificate=TRUE;

Hide discount or coupon text

To remove the discount and coupon text that appears on category and product pages
$noshowdiscounts=TRUE;

Apply discounts after shipping costs (Minimum version 6.2.0)

If you need discounts to kick in after shipping totals have been calculated, set the following

$shippingafterproductdiscounts=TRUE;

Back to top

Customer login

Enable customer login

To enable the customer login box you will need to add the line (if it's not already present)
$enableclientlogin=true;

Wholesale pricing

Wholesale prices can be set for product options. To do this add the parameter
$wholesaleoptionpricediff=TRUE;

You can disable discounts for logged in customers with the wholesale attribute by adding the parameter
$nowholesalediscounts=TRUE;

You can set a separate minimum wholesale purchase amount and message by setting the following
$minwholesaleamount=23.00;
$minwholesalemessage="Your message";

Client login forwarding page

You can set per login level forwarding pages for the client login system or send the logged in client back to the referring page. To set the forwarding page for all pages you can set for instance . . .
$clientloginref="yourpage.php";
Or to use the "referring" page set . . .
$clientloginref="referer";
Or optionally you can set . . .
$clientloginref2="otherpage.php";
. . . to set say a forwarding page for only those logged in with login level 2.

Force customer login

To force customers to create an account before checking out

$forceclientlogin=true;

Self register

To enable customers / clients to self register

$allowclientregistration=true;

Remove login prompt

If you need to remove the prompt on cart.php to login then add this to your vsadmin/includes.php file...

$noclientloginprompt=TRUE;

Customer login link

To provide a link to the customer account in the login minibox, add the following

$customeraccounturl="clientlogin.php";

Customer login default level

If you need to set a login level for new customers then you will need the following

$defaultcustomerloginlevel=2;

...where 2 is the login level that will be applied to all new customers.

Customer login wholesale pricing

If you want a customer to be able to set up an account and see wholesale pricing then you will need the following

$defaultcustomerloginactions=8;

If you want customers to be given a specific discount following log in, you will need the following

$defaultcustomerlogindiscount=20;

... where 20 is the discount that will be applied to all new accounts created.

Set number of login levels

If you want to have more than the default 5 login levels, set the following to have 10 for example

$maxloginlevels=10;

Force customer login onto HTTPS

If you need your customers to login over a secure https connection, set the following

$forceloginonhttps=TRUE;

This will also work for the affiliate login page but you must have the pathtossl set also.

Loyalty / reward points (Minimum version 6.1.0)

To turn on the loyalty points feature, set the following

$loyaltypoints=100;

....where 100 is the number of points per unit of currency eg $1 = 100 points.

The default redemption value for a point will be 0.0001 but that can be changed with

$loyaltypointvalue=0.0001;

Extra client login fields (Minimum version 6.3.0)

It is possible to add two extra fields to the client login admin and account. You can define these in vsadmin/includes.php with the following...

$extraclientfield1;
$extraclientfield2;

If you want to make those required fields you will also need...

$extraclientfield1required=TRUE;
$extraclientfield2required=TRUE;

Back to top

Admin tweaks

Currency formats

Normally the currency is automatically set by your country settings, but sometimes servers don't seem to have locales installed, and some have special needs. These are the parameters available:

$overridecurrency=TRUE;
- Switches the currency overriding on

$orcsymbol="US\$";
- The currency symbol used on product pages.

$orcemailsymbol="US\$";
- The currency symbol used in emails. Normally the same, but can be handy if you wish to set your product page currency symbol to an HTML code like € or ¥ and then in the email set it to EURO or YEN

$orcdecplaces=2;
- How many decimal places your currency has.

$orcdecimals=".";
- The symbol used for the decimal separator. Normally a "." but can be ","

$orcthousands=",";
- The symbol used for the thousands separator. Normally a "," but can be a "."

$orcpreamount=FALSE;
- If you want to display the currency symbol before or after the amount.

$orcurrencyisosymbol="USD";
- If you need to force the settlement in US Dollars even if you are selling from another country.

Please note, the dollar sign ($) is a special character in PHP and so must be preceeded with a slash, as in "US\$"

Adjust date

$dateadjust=3;

...would adjust the date the order status was updated by 3 hours.

$dateadjust=-4;

...would adjust it by minus 4 hours. This is so that if your server time is not the same as your local time then you can adjust for this.

$dateformatstr = "d/m/Y";

...would show the European date format of day / month / year for packing slips

$dateformatstr = "dS F Y";

..would show the date in the format for example 25th May 2004 20:17

Admin date
To set dates in your admin section to US style format (for instance mm/dd/yyyy), set the following
$admindateformat=1;

To set dates in your admin section to UK style format (for instance dd/mm/yyyy), set the following
$admindateformat=2;

cURL

An alternative is provided for those that don't have cURL compiled into PHP, but where the host provides cURL on the command line and you typically receive an error about curl_init() being undefined. To use this feature you need to set the path to the cURL binary on your server in the parameter $pathtocurl. For instance...
$pathtocurl="/usr/local/curl";

cURL for Godaddy hosting

These two parameters are used mainly with GoDaddy hosting where they have disabled the PHP "fsockopen" functions. These are . . .
$usecurlforfsock=TRUE;
. . . which will use the cURL functions instead and . . .
$curlproxy="http://64.202.165.130:3128";
. . . which will set the cURL proxy server to that specified.

If using Wild West Domains through Godaddy then that would be

$usecurlforfsock=TRUE;
$curlproxy="http://proxy.shr.secureserver.net:3128";

Character sets

Greater support is now given for “Wide” Character sets such as Japanese and Chinese. You can set the following 2 switches . . .

$emailencoding="shift_jis";
$adminencoding="shift_jis";

. . . changing “shift_jis” for the actual character encoding used in your emails and admin section pages.

If you are running a store that requires right to left text set the following

$righttoleft=TRUE;

Multiple languages

If you need to have more than one language then set:
$languageid=2;
to indicate which language is being used for that particular admin section.

IP Blocking

To limit the number of transactions in a 24 hour period per IP set:
$blockmultipurchase=10;
...where 10 here is the maximum number of purchases by that particular IP address in 24 hours.

Second store URL

If you need to set up a second store on the same server but for a different domain then use the setting
$orstoreurl="http://www.mysecondsite.com";
in includes.php. This will override the Home URL in the main admin settings.

Admin login

To receive notification of when somebody tries to enter your admin section set:
$notifyloginattempt=TRUE;

To disable the login to your admin section set:
$disallowlogin=TRUE;

This means that you can disable the vsadmin directory and create a copy in a directory with your choice of name that hackers will never know exists.

TinyMCE product admin HTML editor

If you want the built in HTML editor for your product admin page then add this to includes.php . . .
$htmleditor="tinymce";
You will need to download the Tinymce files separately from our downloads page and upload them as per the instructions there.

If you want the styles to be available from your stylesheet then add
$htmleditorstyle='/style.css';

FCKeditor product admin HTML editor

If you want the built in FCKeditor HTML editor for your product admin page then add this to includes.php . . .

$htmleditor="fckeditor";

You will need to download the FCKeditor files separately from our downloads page and upload them as per the instructions there.

CKeditor product admin HTML editor (Minimum version 6.2.0)

If you want the built in CKeditor HTML editor for your product admin page then add this to includes.php . . .

$htmleditor="ckeditor";

You will need to download the CKeditor files separately from our downloads page and upload them as per the instructions there.

State abbreviations

Add...

$usestateabbrev=TRUE;

to use state abbreviations rather than state names.

Static page redirection

If you are using static pages, an attempt to locate the page on the old dynamic URL will result in an HTTP "301 Moved Permanently" and a redirect to the static page. To enable this feature use the following setting in your vsadmin/includes.php file...

$redirecttostatic=TRUE;

Please note, to use this you must have output buffering on the products.php and categories.php pages. To do this, simply open these pages in HTML view and right at the top add this line
ob_start();
right after the line
session_start();

Streamlining search

If you have a very large database and the search feature is running slow you can use the following entries to disable search on certain criteria...

$nosearchdescription=TRUE;

$nosearchlongdescription=TRUE;

$nosearchsku=TRUE;

$nosearchparams=TRUE;

For the product admin search in the control panel...

$nosearchadmindescription=TRUE;

$noautocheckorphans=TRUE;

If you want to set the number of categories per page in the admin (Version 5.9.4 required) set the following...

$admincatsperpage=500;

2 way related products

If you are using the related products feature and want the relation to work both ways ie if you relate Product A to Product B then Product B will automatically be related to Product A without having to set up that relationship, set the following...

$relatedproductsbothways=TRUE;

Date format

If you need the date to show depending on your locale, set the following...

$fordertimeformatstr='%d %B %Y %H:%M';

The available variables can be looked up here http://es.php.net/manual/en/function.strftime.php

Disable admin automatic update checking (Minimum version 5.9.1)

If your host has a firewall installed that blocks access to http://www.ecommercetemplates.com/updaterversions.asp you may find you have problems when the system automatically checks for updates. In this case please set the following...

$disableupdatechecker=TRUE;

This will stop the admin from checking for the latest version of the software and should only really be used if there are connection problems and your host is unwilling to open the Firewall for that URL. Apart from new features, the updaters provide very important security fixes that you can be advised upon through the admin.

Turn off PA-DSS compliance features (Versions 6.1.0 to 6.3.1)

If for testing purposes or if your payment provider does not require you to be PA-DSS compliant and you want to turn off the PA-DSS compliance features, set the following...

$nopadsscompliance=TRUE;

From Version 6.3.2, changes in the way the cart is assessed for PA-DSS means that we no longer have to have some of the more annoying features enabled by default. That means that by default you will not be logged out of admin after 15 minutes, that the admin back button will work, that you don't have to change your password every 90 days and can go back to an old favourite password. If you DO want to enable those features then just set the parameter...

$padssfeatures=TRUE;

Back to top

Image tweaks

Changing default buttons to images

If you would like to use your own images instead of the browser generated buttons for Continue Shopping, Update Totals, Delete, Printable Version, Configure Options and Buy the add the following to vsadmin/includes.php

$imgcontinueshopping="images/imgcontshop.gif";
$imgupdatetotals="images/imgupdtots.gif";
$imgdelete="images/imgdelete.gif";
$imgprintversion="images/imgprintable.gif";
$imgconfigoptions="images/imgconfopts.gif";
$imgbuybutton="images/buy.gif";

$imgbackorderbutton="images/backorder.gif";

For the checkout button you can use an image with this addition

$imgcheckoutbutton="images/othercheckoutimage.gif";

or if you want a button then use

$imgcheckoutbutton="button";

From Version 5.8 use the following if you need different checkout buttons

$imgcheckoutbutton2="images/checkoutbutton2.gif";

...will replace the checkout button on the address details page

$imgcheckoutbutton3="images/checkoutbutton3.gif";

...will replace the checkout button on the final cart page

If you want to change the checkout button on the soft cart use

$imgsoftcartcheckout="images/softimage.gif";

From Version 5.8 all store generated buttons have a corresponding image substitute. There are the ones that can now be used

Search page
$imgsearch="images/gsearch.gif"
Affiliates page
$imgaffiliatelogin="images/affiliatelogin.gif";
$imgaffiliatego="images/affiliatego.gif";
$imgbackacct="images/backacct.gif";
$imgeditaffiliate="images/editaffiliate.gif";
$imglogout="images/logout.gif";

$imgsubmit="images/submit.gif";
Tracking page
$imgtrackinggo="images/trackinggo.gif";
$imgviewlicense="images/viewlicense.gif";
$imgtrackpackage="images/trackpackage.gif";

Order status page
$imgvieworderstatus="images/vieworderstatus.gif";
Client login
$imgcreateaccount="images/createaccount.gif";
$imgforgotpassword="images/forgotpassword.gif";
$imgnewaccount="images/newaccount.gif";
$imgcartaccountlogin="images/cartaccountlogin.gif";
$imgcustomeracct="images/customeracct.gif";
$imgloginaccount="images/loginaccount.gif";
$imglogin="images/login.gif";
$imgsubmit="images/submit.gif";
$imgcancel="images/cancel.gif";
$imgcreatelist="images/createlist.gif";
$imggoback="images/imggoback.gif";

Wish List
$imgaddtolist="images/addtolist.gif";
$imgsaveitems="images/saveitems.gif";
Digital downloads
$imgdownloadproducts="images/downloadproducts.gif";
Notify when back in stock
$imgnotifyinstock="images/notify.gif";
Mini mailing list sign up submit button
$imgmailformsubmit="images/mailsubmit.gif";

In version 6.1 we added images for the send and close buttons on the email a friend / ask a question pop up

$imgefsend="images/sendwin.gif";
$imgefclose="images/closewin.gif"
;

You will need to upload your own images to the main images folder on your store.

Giant image properties

If you are using the giant image linked from the product detail page then to have it appear in a pop-up window, use the following

$giantimageinpopup=TRUE;

To set the height and width of the pop-up window, use

$giantimagepopupwidth=450;
$giantimagepopupheight=600;

If you prefer not to have a pop-up window and have the image open on a separate page then set

$giantimageinpopup=FALSE;

Default product and category image folder

The default folder for product images is /prodimages/ but this can be changed for the location of the product images with this addition

$defaultprodimages = 'newimagefolder/';

... and this one for category images which has a default of /images/

$defaultcatimages = 'newcatimagefolder/';

Shipping logo (Minimum version 6.0.0)

To show your own shipping logo for weight or price based shipping on checkout add this to vsadmin/includes.php

$shippinglogo="images/mylogo.png";

Back to top

Customer reviews

Enable customer reviews and ratings

If you would like your customers to rate and review your products, add this line to vsadmin/includes.php

$enablecustomerratings=TRUE;

Restrict customer reviews to logged in customers only

If you only want logged in customers to be able to add a rating and / or review then set

$onlyclientratings=TRUE;

Customer review display options

You can set the maximum number of reviews and ratings you want to appear on the product detail page with the following addition

$numcustomerratings=6;

To set the number of reviews per page on the all reviews page(s)

$allreviewspagesize=30;

Limit the number of reviews submitted per day

If you want to limit the number of reviews submitted in a 24 hour period then set the following

$dailyratinglimit=10;

Limit the number of characters shown in the review

The default number of characters before the text is truncated is 255 on the product detail page. If you want to show more of the text there then you will need the following setting, for example

$customerratinglength=1024;

Show ratings on the products page

If you would like to show the ratings on the products page with a link to the reviews on the product detail page, add this to includes.php

$ratingsonproductspage=TRUE;

Back to top

Gift certificates

Disable payment types for gift certificate purchase

You may want to disable some payment types if offering gift certificates on your store. For example using Email or Capture Card would mean that the customer receives the certificate before payment. To specify a list of payment providers you want to disable you need to set...

$noemailgiftcertorders="4,10";

...where each number is the id of the payment provider listed in the payment provider admin page. In this case email (4) and capture card (10).

Set minimum value for gift certificates

If you need to set up a minimum purchase value for the gift certificate you will need to set the following...

$giftcertificateminimum=10;

Back to top

Gift registry and Wish Lists

Enable the gift registry feature

To enable the wish list feature you will need to set the following...

$enablewishlists=TRUE;

Add to List link

To show the Add to List link on the product and product detail pages set the following...

$wishlistonproducts=TRUE;

To show the Add to List link on the product detail page only set the following...

$wishlistondetail=TRUE;

Back to top

Spry tabbed panels

Enable the description tab

If you want to get started quickly with the tabbed panels and add one just tab labeled "description", set the following in vsadmin/includes.php...

$defaultdescriptiontab='<ecttab title="Description">';

If you want to replace the text link with an image or icon use...

$defaultdescriptiontab='<ecttab title="Description" img="images/desc.gif" imgov="images/desc_ov.gif">';

Sliding panels

If you would like your text to slide in from the right of the panel, use...

$ecttabs="slidingpanel";

Dyanamic tab content

To show product reviews and related product tabs, add the following...

$ecttabsspecials='<ecttab title="Reviews" special="reviews"><ecttab title="Related" special="related">';

To format the related product tab content use the following...

$relatedtabtemplate='<tr><td class="reltabimage" rowspan="2">%img%</td><td class="reltabname">%name% <br /> %price%</td></tr><tr><td class="reltabdescription">%description%</td></tr>';

The following parameters are available

%img%
%name%
%id%
%price%
%description%

Back to top


Last update

Last updated 26 March 2014