Skip to main content
Version: 4

Creating your First Custom PDF Template – Developers

Introduction​

A template file is used by Gravity PDF to tell the rendering engine exactly how to generate a PDF (i.e. they control the look and feel of the document). These templates are written using HTML, CSS, and PHP. Before we jump right into the code, we're going to discuss the architecture Gravity PDF uses to register and load custom templates, how multisite sites differ from standard WordPress installations, and briefly touch on the template hierarchy.

info

This documentation is written for developers who have a solid understanding of HTML / CSS, PHP, and WordPress development. If you don't have the time or knowledge to do it yourself, we offer a Bespoke PDF service and can tailor a solution specifically for you.

Jump To Section

Working Directory​

The PDF_EXTENDED_TEMPLATES working directory

When Gravity PDF is installed it automatically creates a folder called PDF_EXTENDED_TEMPLATES in your WordPress upload directory. This folder is used to store temporary files, fonts and custom PDF templates. Any PHP files in the root of this folder will be classified as a PDF template1 and the system will automatically register it.

On a vanilla WordPress installation the full path to the PDF_EXTENDED_TEMPLATES directory is /wp-content/uploads/PDF_EXTENDED_TEMPLATES. Your installation may be different if defining custom WP_CONTENT_DIR or UPLOADS constants.

Preparing the Infrastructure​

How to get your server ready for custom PDF templates

Running the Setup Custom Templates tool function from Forms -> Settings -> PDF -> Tools in your admin area will setup the required folder structure and automatically copy all the core templates to the PDF_EXTENDED_TEMPLATES directory so you can easily begin templating. We recommend you copy and rename one of the core templates in PDF_EXTENDED_TEMPLATES to use as a starting point for your custom template.

Multisite Structure​

The PDF_EXTENDED_TEMPLATES multisite working directory

To correctly handle multisite installations the plugin creates a directory in PDF_EXTENDED_TEMPLATES for each active multisite. The folders use the site ID parameter to determine which templates to load. For instance, site #5 will use the folder /wp-content/uploads/PDF_EXTENDED_TEMPLATES/5/ for its templates.

Example of where to find your multisite ID

The site ID can be found by looking at each site's Edit URL in the Network Admin -> Sites section of your admin area (you'll need to be logged in as a network administrator). Alternatively, the site ID column is automatically added to this page when using the Multisite Enhancements plugin.

Template Hierarchy​

When we designed the Gravity PDF template system we used the Theme hierarchy as a starting point. The plugin's core templates are like the parent theme, while the PDF_EXTENDED_TEMPLATES directory acts like a child theme. All core template can be overridden by placing a file with the same name in PDF_EXTENDED_TEMPLATES – which is what happens automatically when you follow the preparing the infrastructure step.

Multisite​

The hierarchy in Multisite installations function a similar way to standard WordPress sites, except there are three hierarchy layers instead of two. The core templates and PDF_EXTENDED_TEMPLATES directory still act like parent and child themes, but the unique site folders act like a child "child theme".

The templates places in the root PDF_EXTENDED_TEMPLATES directory are loaded by all sites in the network. While templates in a site-specific directory – like PDF_EXTENDED_TEMPLATES/5/ – are, well, site specific. Keep in mind templates in site specific folders override templates in the root PDF_EXTENDED_TEMPLATES directory. This setup becomes very useful when duplicating sites in your network, but in most cases you can just drop your custom template in the unique site folders.

Template Structure​

Much like creating plugins or themes, all PDF templates must have the appropriate file headers to tell Gravity PDF more information about your template. Your header should include:

  • Template Name: The name of your template, which will be displayed to the user when selecting templates.
  • Description: A short summary about what your PDF template is for.
  • Version: The current version number of your PDF template.
  • Author: The PDF template author name
  • Author URI: The author's website URL
  • Group: The group your PDF should be assigned to. The group can be anything and helps users find the templates they're looking for.
  • License: The license type the PDF template is released under e.g GPLv2
  • Required PDF Version: The minimum Gravity PDF version required to run the template.
  • Tags: Any PDF tags that can be used to better search for the plugin in the PDF Template Manager

A valid header might look like this:

/**
 * Template Name: Zadani
 * Version: 1.2
 * Description: A minimalist business-style template that will generate a well-spaced document great for printing. Through the Template tab you can control the PDF header and footer, change the background color or image, and show or hide the form title, page names, HTML fields and the Section Break descriptions.
 * Author: Gravity PDF
 * Author URI: https://gravitypdf.com
 * Group: Core
 * License: GPLv2
 * Required PDF Version: 4.0
 * Tags: Header, Footer, Background, Optional HTML Fields, Optional Page Fields, Container Background Color
 */

Variables Available​

Overview of the available variables in PDF templates

The following variables are available to all PDF templates:

$form : The current Gravity Form object being processed. This is the main object in Gravity Forms and contains all properties of a particular form – form title, fields, notification, confirmation ect.

$entry : The current Gravity Form entry object being processed. This object contains all properties of a particular entry in raw format – accessing field data directly from the object should be avoided. The object is formatted as an associative array and the field IDs are the array keys.

$lead : An alias for $entry

$form_data : The formatted $entry data stored in an associative array. View full documentation on the $form_data array.

$settings : The current PDF configuration settings in array format. Standard settings like filename and font size are stored in this array, as well as template-specific settings.

$fields : An array of the current Gravity Forms fields which can be accessed using their field ID number – print_r( $fields[20] );. This is just a formatted version of the $form['fields'] array.

$gfpdf : This is the main Gravity PDF object which contains all our helper classes (including data, form, options, notices, misc and log). Power users may find this useful.

$args : An associative array containing all of the above variables. For instance $args['form'] or $args['entry'] reference $form and $entry, respectively.

For backwards compatibility, these variables are available to templates but are deprecated:

$form_id : The current form ID being processed. We recommend you use $form['id'] or $entry['form_id'] instead.

$lead_id : The current entry ID being processed. We recommend you use $entry['id'] instead.

$lead_ids : An array of the selected entries to be processed. This array was used in Gravity PDF v3 to process multiple entries in a single PDF, but this had a lot of performance problems and has been removed in v4+. We strongly recommend against using this.

Template Tutorial – Part 1​

The basic Hello World PDF template

Now we've got all the theory out of the way let's create our first PDF template. In the traditional fashion, this will be a basic "Hello World" PDF.

To get started, create a new PHP file in your IDE of choice and call it hello-world.php. We're going to add the following headers to the file to tell Gravity PDF about the template:

<?php

/**
 * Template Name: Hello World
 * Version: 0.1
 * Description: A basic "Hello World" PDF template showing custom PDF templates in action
 * Author: Jake Jackson
 * Author URI: https://gravitypdf.com
 * Group: Sol System
 * License: GPLv2
 * Required PDF Version: 4.0
 * Tags: space, solar system, getting started
 */

/* Prevent direct access to the template (always good to include this) */
if ( ! class_exists( 'GFForms' ) ) {
    return;
}

As you can see it's very simple to let Gravity PDF know about your PDF template. More information about each individual header is available in the Template Structure section.

Next we're going to layout the basic structure. Go ahead and add the following below the header section:


?>

<!-- Any PDF CSS styles can be placed in the style tag below -->
<style>

</style>

<!-- The PDF content should be placed in here -->

Think of Gravity PDF templates as HTML that is automatically included inside the <body> tag – unlike Gravity PDF v3 templates you won't need to add a <!DOCTYPE html> or <head></head> mark-up. Any supported CSS can be placed in the <style> tags, while your actual content should be included below that. Simple!

To finish off our example we've going to replace <!-- The PDF content should be placed in here --> with <h1>Hello World</h1>. Once done, save the example and upload it to your PDF working directory.

Download a completed copy of the Hello World template.

Viewing PDF​

The new Sol System PDF group

Once you've uploaded the template you'll be able to see your new Sol System group added to the template field when configuring new form PDF templates. Go ahead and configure a new form PDF with your Hello World template and then view the PDF. You should see a PDF with "Hello World" written in large text.

Adding Styles​

If you would like to change the appearance of the PDF we can add new styles to the document. We're going to change the <h1> tag appearance by adding the following CSS inside the <style> tag:

h1 {
	text-align: center;
	text-transform: uppercase;
	color: #a62828;	
	border-bottom: 1px solid #999;
}

Save and upload the template again. When you view it you'll see the heading is now centre-aligned, burgundy in colour, with a bottom border. How easy is that!

Download a completed copy of the Hello World template with the styling added.

Just keep in mind that the PDF software doesn't function exactly like a web browser. Not all HTML or CSS is supported in PDFs and cascading CSS support is limited.

Footnotes​

  1. For legacy reasons ensure you don't name your template configuration.php or configuration.archive.php. ↩

Last updated on