Order Form Templates - Revision history

SarahK at 20:53, 26 April 2022

2022-04-26T20:53:51Z

SarahK at 19:24, 18 January 2022

2022-01-18T19:24:19Z

SarahK at 22:03, 20 November 2020

2020-11-20T22:03:51Z

Show changes

John: /* Template Files */

2020-09-22T10:13:55Z

‎Template Files

SarahK at 13:08, 5 August 2020

2020-08-05T13:08:15Z

SarahK at 21:03, 29 April 2020

2020-04-29T21:03:43Z

Show changes

John: /* Built-in Order Form Templates */

2018-07-19T15:26:16Z

‎Built-in Order Form Templates

NickH: /* Introduction */

2017-09-19T03:35:21Z

‎Introduction

NickH: /* Introduction */

2017-09-19T03:35:07Z

‎Introduction

John: /* Creating a New Template based on a Parent */

2016-08-22T09:07:56Z

‎Creating a New Template based on a Parent

@@ Line 14: / Line 14: @@
 You can set Order Form templates in two locations.
-* '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Ordering''' or, prior to WHMCS 8.0, '''Setup > General Settings > Ordering'''. This defines the system default order form template. By default, this is ''Standard Cart''.
+* The '''[[Ordering Tab|Ordering]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''. This defines the system default order form template. By default, this is ''Standard Cart''.
-* '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services''' on a per-product group basis. To set this, create or edit a product group. Selecting an Order Form template here will override the system default when viewing that product group in the client area. It will also define the styling for the product configuration part of the order process for products and bundles within that group.
+* The product group at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products and Services|Products/Services]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services'''. To set this, create or edit a product group. Selecting an Order Form template here will override the system default when viewing that product group in the client area. It will also define the styling for the product configuration part of the order process for products and bundles within that group.
 <div class="docs-alert-warning">
 The view cart and checkout steps will always use the default order form template. This is because the cart can contain products from many different product groups at the same time.
 </div>
@@ Line 28: / Line 27: @@
 To do this, use a URL that resembles <tt>http://www.example.com/whmcs/?carttpl=xxxxx</tt>. In this URL, <tt>xxxxx</tt> is the name of the order form template directory.
-<div class="docs-related-pages">For more information, see [[Linking to WHMCS]].</div>
+For more information, see [[Linking to WHMCS]].
 ==Template Files==
@@ Line 50: / Line 49: @@
 * <tt>linkedaccounts.tpl</tt> — Includes any activated Social [[Sign-In Integrations]].
 * <tt>login.tpl</tt> — Displays the login page for existing users (WHMCS 8.0 and earlier).
-* <tt>marketconnect-promo.tpl</tt> — Promotes MarketConnect products when the client views the cart (WHMCS 7.6 and later).
+* <tt>marketconnect-promo.tpl</tt> — Promotes [[MarketConnect]] products when the client views the cart (WHMCS 7.6 and later).
 * <tt>ordersummary.tpl</tt> — Displays cart contents and product total summaries during the order process.
 * <tt>products.tpl</tt> — Lists product categories and products.
@@ Line 74: / Line 73: @@
 <div class="docs-alert-info">
 <span class="title">Template Locations</span><br />
-* '''Standard Cart''' is under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Ordering''' or, prior to WHMCS 8.0, '''Setup > General Settings > Ordering'''.
+* '''Standard Cart''' is in the '''[[Ordering Tab|Ordering]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.
-* '''Premium Comparison''' is for the product groups that will use its product selection page at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.
+* '''Premium Comparison''' is for the product groups that will use its product selection page at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products and Services|Products/Services]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.
 </div>
@@ Line 81: / Line 80: @@
 <div class="docs-alert-info">
 We only support this in WHMCS 6.1.0 and later.
 </div>
@@ Line 94: / Line 92: @@
 In the above example, <tt>standard_cart</tt> is the name of the parent template we're using.
-At this stage, the new order form template is ready. You can activate it at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Ordering'''. You can also now select the custom Order Form template name within the configuration area for a specific product group.
+At this stage, the new order form template is ready. You can activate it in the '''[[Ordering Tab|Ordering]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''. You can also now select the custom Order Form template name within the configuration area for a specific product group.
 If you want to customize a step in the ordering process, follow these steps:
@@ Line 101: / Line 99: @@
 # Copy that order form template file from the defined parent order form template to the new directory.
 # Make the desired changes to the copy within the custom order form template directory.
-# Enable the new order form template. The custom order form template will load the step that has had customization. Other steps will load from the parent order form template. Usually, the parent order form template is the system default in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Ordering''' or, prior to WHMCS 8.0, '''Setup > General Settings > Ordering'''.
+# Enable the new order form template. The custom order form template will load the step that has had customization. Other steps will load from the parent order form template. Usually, the parent order form template is the system default in the '''[[Ordering Tab|Ordering]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.
-Then, select the custom order form template in the necessary product groups in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.
+Then, select the custom order form template in the necessary product groups in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products and Services|Products/Services]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.
 ==Third Party Order Conversion/Affiliate Tracking==
@@ Line 118: / Line 116: @@
 <div class="docs-alert-info">
 Many variables, including <tt>{$orderid}</tt>, <tt>{$ordernumber}</tt>, and <tt>{$amount}</tt>, are available. Use these where necessary to fill in order details.
 </div>

@@ Line 26: / Line 26: @@
 You can also specify an order form using a crafted URL. An order form template that you create using this method takes precedence over the system order form template or product group order form template. This will last for the duration of the user's visit.
-To do this, use a URL that resembles <tt>http://www.yourdomain.com/whmcs/?carttpl=xxxxx</tt>. In this URL, <tt>xxxxx</tt> is the name of the order form template directory.
+To do this, use a URL that resembles <tt>http://www.example.com/whmcs/?carttpl=xxxxx</tt>. In this URL, <tt>xxxxx</tt> is the name of the order form template directory.
 <div class="docs-related-pages">For more information, see [[Linking to WHMCS]].</div>

@@ Line 33: / Line 33: @@
 Order Form templates exist in the '''/templates/orderforms/''' directory. Each subdirectory is a different order form template. Within those directories, you will find the following files:
-* <tt>products.tpl</tt> — Lists product categories and products.
+* <tt>products.tpl</tt> — Lists product categories and products
-* <tt>adddomain.tpl</tt> — Begins the process for domain registration-only orders.
+* <tt>adddomain.tpl</tt> — Begins the process for domain registration-only orders
-* <tt>addons.tpl</tt> — Lists the addons a user can order for their existing packages when they log in.
+* <tt>addons.tpl</tt> — Lists the addons a user can order for their existing packages when they log in
-* <tt>domainrenewals.tpl</tt> — Lists domains in the client's account. This can also allow for domain renewals to in advance.
+* <tt>domain-renewals.tpl</tt> — Lists domains in the client's account. This can also allow for domain renewals to in advance
-* <tt>configureproductdomain.tpl</tt> — Allows domain selection for domains for a specific product.
+* <tt>configureproductdomain.tpl</tt> — Allows domain selection for domains for a specific product
-* <tt>domainoptions.tpl</tt> — For some templates, displays domain availability check results.
+* <tt>domainoptions.tpl</tt> — For some templates, displays domain availability check results
-* <tt>configureproduct.tpl</tt> — Configures the product before adding it to the cart (for example, thebilling cycle, configurable options, or custom fields).
+* <tt>configureproduct.tpl</tt> — Configures the product before adding it to the cart (for example, thebilling cycle, configurable options, or custom fields)
-* <tt>configuredomains.tpl</tt> — Chooses domain addons, complete custom field requirements, and custom nameservers.
+* <tt>configuredomains.tpl</tt> — Chooses domain addons, complete custom field requirements, and custom nameservers
-* <tt>ordersummary.tpl</tt> — Displays cart contents and product total summaries during the order process.
+* <tt>domainregister.tpl</tt> — Domain searching and suggestions
-* <tt>viewcart.tpl</tt> — Displays cart contents and the checkout process.
+* <tt>domaintransfer.tpl</tt> — Domain transfers eligibility check and EPP code provision
-* <tt>login.tpl</tt> — Displays the login page for existing users.
+* <tt>ordersummary.tpl</tt> — Displays cart contents and product total summaries during the order process
-* <tt>complete.tpl</tt> — Displays at the end of the checkout process.
+* <tt>viewcart.tpl</tt> — Displays cart contents, tax estimator and promotion code applicator
 ==Creating a Custom Order Form Template==

@@ Line 15: / Line 15: @@
 Definition of Order Form templates can occur in two locations.
-The first is in '''Setup > General Settings > Ordering'''.  This defines the system default order form template directory.  By default, this is ''Standard Cart''.
+The first is in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Ordering''' or, prior to WHMCS 8.0, '''Setup > General Settings > Ordering'''.  This defines the system default order form template directory.  By default, this is ''Standard Cart''.
-There is also an option to configure an Order Form template on a per-product group basis.  To do this, navigate to '''Setup > Products/Services > Create/Edit Product Group'''.  Selecting an Order Form template here will override the system default when viewing that product group in the client area. It will also define the styling for the product configuration part of the order process for products and bundles within that group.
+There is also an option to configure an Order Form template on a per-product group basis.  To do this, navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services'''.  Then, create or edit a product group. Selecting an Order Form template here will override the system default when viewing that product group in the client area. It will also define the styling for the product configuration part of the order process for products and bundles within that group.
 <div class="docs-alert-warning">Note: The view cart and checkout steps will always use the default order form template. This is because the cart can contain products from many different product groups at the same time.</div>
@@ Line 64: / Line 64: @@
 <div class="docs-alert-info">
 <span class="title">TIP: </span><br />
-* The "Standard Cart" order form template is under '''Setup > General Settings > Ordering tab'''.
+* The "Standard Cart" order form template is under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Ordering''' or, prior to WHMCS 8.0, '''Setup > General Settings > Ordering'''.
-* The "Premium Comparison" order form is for the product groups that will use its product selection page at '''Setup > Products/Services > Products/Services > Edit Group'''.
+* The "Premium Comparison" order form is for the product groups that will use its product selection page at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.
 </div>
@@ Line 87: / Line 87: @@
 #Copy that template file from the defined parent template to the new template directory.
 #Make the desired changes to the copy within the custom template directory.
-#Enable the new order form to see it in action. The custom order form will load the step that has had customisation. Other steps will load from the parent order form template. Usually, the parent template would be the system default, in Setup > General Settings > Ordering tab.
+#Enable the new order form to see it in action. The custom order form will load the step that has had customisation. Other steps will load from the parent order form template. Usually, the parent template would be the system default, in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Ordering''' or, prior to WHMCS 8.0, '''Setup > General Settings > Ordering'''.
-Selection of the custom template would then occur in the necessary product groups in Setup > Products/Services > Products/Services > Edit Group.
+Selection of the custom template would then occur in the necessary product groups in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.
 ==Third Party Order Conversion/Affiliate Tracking==

← Older revision		Revision as of 15:26, 19 July 2018
Line 8:		Line 8:

	<div class="docs-related-pages">See [[Standard Order Form Templates]] for information on Order Form templates and functionality.</div>		<div class="docs-related-pages">See [[Standard Order Form Templates]] for information on Order Form templates and functionality.</div>
		+
		+	Details of deprecated and discontinued order form templates are located at [[Discontinued Order Form Templates]].

	==Configuring the Order Form Template==		==Configuring the Order Form Template==

@@ Line 1: / Line 1: @@
 ==Introduction==
-Order Form2 Templates define the look and feel of the shopping cart process.
+Order Form Templates define the look and feel of the shopping cart process.
 ==Built-in Order Form Templates==

@@ Line 72: / Line 72: @@
 <div class="docs-alert-info">The following is supported in WHMCS 6.1.0 and later only.</div>
-After creation of a custom order form template, WHMCS needs to know the parent template. Create a YAML file within the new directory to do this. Name the YAML file ''theme.yaml' and include the following:
+After creation of a custom order form template, WHMCS needs to know the parent template. Create a YAML file within the new directory to do this. Name the YAML file ''theme.yaml'' and include the following:
 <source lang="yaml">