Print Template
Developer Documentation

Overview

Print Manager plugin supports the ability to add Custom Print Templates as plugin add-ons. 

The Custom Print Template functionality for the Print Plugin would be the recommended solution for any custom fields required to be added or removed to a print-out receipt template or compatibility with other plugins not supported by default in the print templates included.

The print templates support a global $order variable, using $order->get_meta. This allows you to develop a Custom Print Template and add or remove all the fields you may require in the print-out receipt layout you want.

Important Note: We don’t recommend modifying the default templates under the /templates directory of the plugin. Print Manager plugin updates will override the modified template. Plus, we can’t guarantee the template format you modified will work in the future. We can commit to supporting the Custom Print Template solution in future releases as the correct solution for custom templates working with the plugin.

---

Plugin Development Structure 

Adding custom templates

To init custom templates after loading zprint call wp hook zprint_loaded

this will prevent plugin loading errors by using zprint API add_action('zprint_loaded', 'your_plugin_init_function_name');

Now the zprint_loaded – wp action, will be called after successfully loading zprint.

ZprintTemplates::registerTemplate – static method, require object, implements `ZprintTemplateIndex` interface

ZprintTemplateIndex

required to implement methods in your class:
getName() – return name of your template (string)
getSlug() – return slug (string)
getPath($format) – accept $format (`plain`, `html`), return path to layout file (string)
getFormats() – return assoc array of formats, indicate which formats supports your template type, for example:
['html' => true, 'plain' => false].

Supports custom formats (for example: html): ['key_format' => 'Format name']

For custom options for your template, implement ZprintTemplateOptions interface, renderOptions, processOptions methods.
renderOptions($options) – accept current options assoc array, should render html with input to display them in location form
processOptions($options) – accept current options assoc array, should return new assoc array with data. You can access to new data by $_POST

In each template file you can access a few data and settings variables.
$templateOptions – assoc array include current template options

About shipping settings

$location_data['shipping']['method'] – show shipping method
$location_data['shipping']['billing_shipping_details'] – show billing and shipping details
$location_data['shipping']['customer_details'] – show customer details
$location_data['shipping']['cost'] – show shipping cost

Additional useful methods and functions

Zprintget_appearance_setting($name), accept name setting from General tab Print Settings.

Allowed names: logo,Order Header, Check Header, Company Name, Company Info, Order Details Header, Footer Information #1, Footer Information #2

Return string or src path for logo

ZprintOrder::getHiddenKeys() return array of keys for order item meta (item_meta from $order->get_items()) which should not display.

You can apply own keys by woocommerce_hidden_order_itemmeta filter.

Plain output format

class ZprintDocument include static methods to format strings:

Document::centerLine($string) – printer centered string
Document::emptyLine() = print empty string
Document::symbolsAlign($left, $right) – print two string parts joined by spaces in column format
Document::line($string) – print string in line

These methods supports word wrap. You can enable Print symbols for layout debug in location settings. It replaces the align spaces to dots for better layout debug.