...
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 | |||||||
---|---|---|---|---|---|---|---|---|---|---|
{{ | {{ htmlcontent }} | }}Loads the directional and language settings | Displays the main content for the site. | Must be placed inside theYes | This content changes each time a new page is loaded. | yes | 4.0 | |||
{{ | {{ headerleft }} | }}Loads everything that is to be placed within | YesPrimary side block. Loads blocks 1 & 9. | yes | 4.0 | |||||
{{ | {{ titleright }} | }}Displays the site title. Must be placed inside the HTML | Yes | 4.0 | {{{{ body }}}} | Loads id and class of | YesSecondary side block. Loads blocks 3 & 10 | yes | 4.0 | |
{{ | {{js }} | }}Loads all Javascript files at the footer. This must be placed before the </body> closing tag. | Yesyes | 4.0 | ||||||
{{ | {{ contenttitle }} | }}Displays the | main content for thesite | . This content changes each time a new page is loaded.Yestitle. Must be placed inside the HTML <title></title> elements. | yes | 4.0 | ||||
{{ | {{ errorsheader }} | }}Displays any errors to the end user. This is usually placed above {{{{ content }}}}. | YesLoads everything that is to be placed within <head></head>. | 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 | html }} | Loads the directional and language settings for the site. Must be placed inside the <html> element.
| yes | 4.0 | ||||
{{ body }} | Loads the pages ID and Class names. Must be placed inside the <body> element.
| yes | 4.0 | |||||||
{{ | {{sticky_ | bar_smbar }} | }}Loads the notification panel for when a user is logged in. | (Small screen)No | yes | 4. | x0 | |||
{{ | {{ sticky_bar_xslocation_11 }} | }}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 | |||||||
This loads block 11 and is where the main header for a user profile is loaded. Its intended to | yes | 4.0 | ||||||||
{{ breadcrumb }} | Loads the sites breadcrumb, which include section titles and <h1></h1> tags for when viewing an item. | Yesyes | 4.0 | |||||||
{{ | {{main_top }} | }}Some sections support internal searching of that section. This loads the main search routine for these sections. | Yesyes | 4.0 | ||||||
{{ | {{ logoerrors }} | }}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 | No | 4.x | |||||||
Displays any errors to the end user. This is usually placed above {{ content }}. | yes | 4.0 | ||||||||
{{ logo }} | Loads the sites logo and allows Admins to change it directly from the AdminCP. | yes | 4.0 |
Functions
Functions allow you to apply conditional statements to templates and access objects passed along by phpFox.
Name | Description | Usage | 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 string $route, | int int $id, | string string $title) | <br><br>
$route | : URL path for your link. | <br>$id | : Unique ID number. | <br>
$title | : Title of the item
| Creates a permalink. This is an identical function provided by our PHP permalink() function. | This 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) | <br><br>
$route | : Route for your link. | Creates a link based on the route provided. |
| Parsed URL. | ||||||||||
_p(string $phrase) | <br><br>
$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) | <br><br>
$image | : Relative path to image in your themes assets/ folder. | Include images in your themes. | URL of image. | |||||||||||
| Shorten string. | Shortened string. | |||||||||||||
| Diplay large number in short type.<br>Ex: | Short type number. | |||||||||||||
| Get value of a setting. | Value of given setting. | |||||||||||||
| Get value of a user group setting. | Value of given user group setting. | |||||||||||||
| Parse text. This function usually be used when we need to display text that added by user input. | Parsed string. | |||||||||||||
| Parse text. This function usually be used when we need to display text that added by user input. | Parsed string. | |||||||||||||
| Display block comment. | Block comment HTML. | |||||||||||||
| Display block payment. | Block payment HTML. | |||||||||||||
| Display block pagination. | Block pagination HTML. | |||||||||||||
| Get translated phrase. | Translated phrase. | |||||||||||||
| Get translated phrase. | If | |||||||||||||
| Get path/load asset files in HTML. | If | |||||||||||||
| URL of image. |