Template Variables

We use Twig as our default template engine. If you haven't worked with Twig or the Liquid Templating language, make sure to read up on how Twig works here.

In addition to the variables and functions supported by Twig, we have a few custom variables/functions for you to work with.

Variables

Variables are needed to fill out your template with dynamic data that is provided by phpFox. These are things from the main content, side panels and the sites title.

Variable	Description	Required	Version Added
`{{ html }}`	Loads the directional and language settings for the site. Must be placed inside the `<html>` element. `<html {{ html }}>`	Yes	4.0
`{{ header }}`	Loads everything that is to be placed within `<head></head>`.	Yes	4.0
`{{ title }}`	Displays the site title. Must be placed inside the HTML `<title></title>` elements.	Yes	4.0
`{{ body }}`	Loads id and class of `body`	Yes	4.0
`{{ js }}`	Loads all Javascript files at the footer. This must be placed before the `</body>` closing tag.	Yes	4.0
`{{ content }}`	Displays the main content for the site. This content changes each time a new page is loaded.	Yes	4.0
`{{ errors }}`	Displays any errors to the end user. This is usually placed above `{{ content }}`.	Yes	4.0
`{{ share }}`	Current user actions.	No	4.x
`{{ menu }}`	Loads the site menu.	Yes	4.x
`{{ sticky_bar }}`	Loads the notification panel for when a user is logged in.	Yes	4.0
`{{ sticky_bar_sm }}`	Loads the notification panel for when a user is logged in. (Small screen)	No	4.x
`{{ sticky_bar_xs }}`	Loads the notification panel for when a user is logged in. (Extra small screen)	No	4.x
`{{ nav }}`	Combines from `{{ share }}`, `{{ menu }}` and `{{ sticky_bar }}`.	No	4.x
`{{ notify }}`	This component same as `{{ sticky_bar }}`.	No	4.x
`{{ location_x }}`	Loads all blocks belong to location x (x from 1 to 12).	Yes	4.x
`{{ breadcrumb }}`	Loads the sites breadcrumb, which include section titles and `<h1></h1>` tags for when viewing an item.	Yes	4.0
`{{ main_top }}`	Some sections support internal searching of that section. This loads the main search routine for these sections.	Yes	4.0
`{{ logo }}`	Loads the sites logo and allows Admins to change it directly from the AdminCP.	Yes	4.0
`{{ breadcrumb_menu }}`	Actions menu	Yes	4.x
`{{ site_logo }}`	Site name	No	4.x
`{{ site_link }}`	Print url of site	No	4.x
`{{ menu_sub }}`	Loads the sub menu (below main menu)	Yes	4.x
`{{ search }}`	Loads search field.	No	4.x
`{{ footer }}`	Loads the site footer.	No	4.x
`{{ copyright }}`	Loads the copyright of site.	No	4.x
`{{ top }}`	Loads location 7 and 11.	No	4.x
`{{ main_top }}`	Loads location 7 with search field above.	No	4.x
`{{ left }}`	Loads location 1 and 9.	No	4.x
`{{ right }}`	Loads location 3 and 10.	No	4.x
`{{ h1 }}`	Loads current page header.	No	4.x
`{{ menu_nav }}`	Loads current page header.	No	4.x
`{{ main_class }}`	Loads classes of `#main` element.	No	4.x

Functions

Functions allow you to apply conditional statements to templates and access objects passed along by phpFox.

Name	Description	Returns
`is_user()`	Checks to see if a user is logged in or not.	true on success, false on failure.
`is_admin()`	Checks to see if a user is an admin.	true on success, false on failure.
`permalink(string $route, int $id, string $title)` `$route`: URL path for your link. `$id`: Unique ID number. `$title`: Title of the item	Creates a permalink. This is an identical function provided by our PHP permalink() function. This is handy when you want to create an App that requires viewing an item, like a blog or video. This function follows our default permalink rules and structure.	Parsed permalink.
`url(string $route)` `$route`: Route for your link.	Creates a link based on the route provided.	Parsed URL.
`_p(string $phrase)` `$phrase`: Phrase to parse.	If your theme has any phrases or words you can wrap them in this function. It will automatically create a phrase for Admins in case they wish to translate your theme.	Returns the phrase passed to the function if the translation does not exist. Otherwise it returns the translated version.
`asset(string $image)` `$image`: Relative path to image in your themes assets/ folder.	Include images in your themes.	URL of image.
`shorten(string $str, int $max_length)` `$str`: String to shorten. `$max_length`: number of characters that `$str` will be shorten if longer than.	Shorten string.	Shortened string.
`short_number(int $number)` `$number`: number to display in short type.	Diplay large number in short type. Ex: `short_number(1200)` // this function will return `1k+`	Short type number.
`setting(string $var_name)` `$var_name`: setting var name.	Get value of a setting.	Value of given setting.
`user_group_setting(string $var_name)` `$var_name`: user group setting var name.	Get value of a user group setting.	Value of given user group setting.
`parse(string $str)` `$str`: text to parse.	Parse text. This function usually be used when we need to display text that added by user input.	Parsed string.
`parse(string $str)` `$str`: text to parse.	Parse text. This function usually be used when we need to display text that added by user input.	Parsed string.
`comments()`	Display block comment.	Block comment HTML.
`payment()`	Display block payment.	Block payment HTML.
`pager()`	Display block pagination.	Block pagination HTML.
`_p(string $var_name)` `$var_name`: phrase var name	Get translated phrase.	Translated phrase.
`moment(int $timestamp)` `$timestamp` (optional): timestamp to convert to time phrase.	Get translated phrase.	If `$timestamp` is null, the result will be current timestamp, otherwise, the result will be time phrase (Ex: '5 seconds ago', '3 minutes ago'...).
`asset($assetPath)` `$assetPath` (string or array): path to asset files.	Get path/load asset files in HTML.	If `$assetPath` is string, the result will be the path to that asset. If `$assetPath` is array, it will load asset files directly to HTML.

Page tree

Template Variables

Variables

Functions