Page tree
Skip to end of metadata
Go to start of metadata

 

Introduction

Template Toolkit is the main template system for the cPanel and WHM interfaces. This system uses the Template Toolkit Perl library to create templates that can, for example, perform calls to the cPanel APIs and UAPI.

Note:

  • Whenever you customize existing template files, we strongly recommend that you back up all of the files before you edit them. 
  • This documentation focuses on cPanel & WHM-specific uses of Template Toolkit files. If you have not used Template Toolkit previously, we recommend that you start with template-toolkit.org's Template::Tutorial::Web tutorial.

Access the Template Toolkit system

Use cptt tags to access the Template Toolkit system from HTML files. cptt tags reference a file that is relative to the /usr/local/cpanel/base/frontend/theme directory, where theme represents the cPanel theme (paper_lantern or another valid theme on the server).

For example, to call the /usr/local/cpanel/base/frontend/paper_lantern/templatefile.tmpl file from within an HTML file, use the following code in a Paper Lantern theme page:

<?cptt templatefile.tmpl ?> 

Note:

HTML files and the .tmpl files that they call must exist in the same directory.