Custom includes

Three of your own templates can be injected: one into the document head, one before the closing body tag, and one above the checkout summary. Use the first two for analytics, tracking pixels, support widgets or anything else that has to appear on the checkout, and the third for a message about the order, such as how much more it takes to earn free shipping.

Setting them#

Control panel: Checkout -> General, under Head include, Body include and Summary include. Enter a template path relative to your templates directory, without the file extension.

Config file: set the includes key in config/foster-checkout.php.

'includes' => [
    'head' => '_includes/checkout/head',
    'body' => '_includes/checkout/body',
    'summary' => '_includes/checkout/summary',
],

The config file wins over the control panel. A key set there pins that one field; the others stay editable. See settings.

Saving in the control panel rejects a Head include or Body include path with no template behind it. Summary include is not checked, and neither is a path set through the config file. A missing template throws on every page that renders it.

What your template receives#

The head and body includes render on every cart and checkout page, so branch on step to target a single one. The summary include renders wherever the checkout summary does: single-page on the one page layout, and the step’s own name on each step of the stepped layout.

{% if context == 'checkout' and step == 'confirmation' %}
	{# Purchase tracking goes here, once the order exists #}
{% endif %}

Tips#

Only the four variables above are a contract. The includes also inherit the surrounding template’s variables, which is how order is reachable on the confirmation page even though the plugin never passes it. Anything beyond the four can move without warning.

The summary include renders once, on page load. It does not re-render when the single-page checkout changes the shipping method or coupon.

It gets its own bordered container, and only when it renders something. A template that outputs nothing for this cart leaves no empty box, so branch inside it rather than setting the include conditionally.