Register Members List Search Today's Posts Mark Forums Read

Reply
 
Article Options
vBulletin 4 Template Syntax: General
Marco van Herwaarden
Join Date: Jul 2004
Posts: 25,415

by Marco van Herwaarden Marco van Herwaarden is offline 23 Aug 2009

The content of this article is also available in your vBulletin distribution in ./readme-syntax.html.

vBulletin 4 Template Syntax

vBulletin 4.0 introduces a rich new syntax for marking-up templates, reducing the need for formatting and escaping to be performed in .php files.

Note that once a template makes use of any vBulletin 4 template syntax, the old syntax will cease to operate for that template. Conversions must be an all-or-nothing affair.


Variable Access

Safe Variables

Going forward, variables should be referenced in templates wherever possible using the following syntax:


Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

Variables accessed in this manner are 'made safe' by being run through htmlspecialchars as they are output.

To access array elements, use a dot operator, rather than standard PHP square brackets:


Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

Raw Variables

To access variables in the normal, pre-vB4 fashion, use the following syntax:

Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.


This is equivalent to simply accessing $variable in the pre-vB4 syntax. No treatment is applied to the variable. The same dot operator is used to access array elements.

Curly-Brace Syntax

The general syntax here is

Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

Inside curly braces, variables can be accessed without using a separate set of surrounding braces. For example,

Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.


Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

Built-in Methods

phrase
Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

Inserts the specified phrase. If arguments are provided, they will be run through htmlspecialchars.

rawphrase
Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

As above, though arguments bypass htmlspecialchars.

Example:
Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.



date
Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

Formats a UNIX timestamp using the default date format for the active language. A format may also be explicitly specified. Timezone will be corrected for the viewing user.

time
Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

As above, though uses the default time format instead of date format.

number
Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

Outputs a number having run through vb_number_format for correct locale formatting. Number of decimal places to display can be optionally specified.

raw
Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

Outputs the variable raw, without any formatting or escaping.

escapejs
Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

Returns the variable prepared for use as a Javascript single-quoted string instead of running htmlspecialchars.

urlencode
Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

Escapes the variable using urlencode.

if
Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

Use this in instances where the full <vb:if> tag can not be used, such as within HTML tags.

link
Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

Used to build a hyperlink URL of the specified type and into the correct 'friendly' format.

math
Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

Primarily used within CSS, this is used to evaluate the result of the mathematical expression specified.

stylevar
Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

Used to output a style variable from the style system. No escaping is performed.

Tags

All tags make use of the vb namespace for ease of identification and parsing.

The following tags are available:

literal
Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

Any code inside vb:literal tags will be treated as plain HTML. No curly-brace syntax or vb:tag markup will be evaluated.

if
Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

If the expression specified in condition is true, the contents of the vb:if tags will be output, otherwise nothing will be output.

elseif
Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

Used in conjunction with vb:if, this allows a secondary condition to be checked and the true result to be output if the condition is met.

else
Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

Used in conjunction with vb:if, the true result will be output if the vb:if condition failed, and so did any vb:elseif checks.

comment
Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

In cases where a comment is necessary but the usual <!-- comment --> syntax is undesirable, the vb:comment tag allows its contents to be completely removed upon compiling, so they will not be delivered to the browser. Useful for internal commenting.

each
Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

This tag will iterate through an array, in a similar manner to foreach. See the example use below.

Example Use of vb:each


Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

Views: 9315
Reply With Quote
Comments
  #2  
Old 23 Aug 2009, 16:55
cellarius's Avatar
cellarius cellarius is offline
 
Join Date: Aug 2005
Real name: Sven
Some more verbose documentation of the new link-method would really be appreciated. For which types of pages is it operative, and what parameters can or have to be provided?
__________________
Please note that there will be no further updates to my addons, especially they will not be upgraded for vB5. I'm leaving vB, since IB choose to go the banana-way yet again.

http://www.roma-antiqua.de
Reply With Quote
  #3  
Old 23 Aug 2009, 19:41
Paul M's Avatar
Paul M Paul M is offline
 
Join Date: Sep 2004
Real name: Paul M
Note that for "each" , the key part (in red) is optional.


Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

__________________
Former vBulletin.org Staff Member


Cable Forum
Please do not PM me about custom work - I no longer undertake any.
Note: I will not answer support questions via e-mail or PM - please use the relevant thread or forum.
Reply With Quote
  #4  
Old 24 Dec 2009, 17:49
ragarcia87's Avatar
ragarcia87 ragarcia87 is offline
 
Join Date: Jun 2009
Real name: Ryn Garcia
Has to be the worst template documentation ever. Basically this doc is a waste of time since there is soo little information in it. Not helpful what so ever, more of a hindrance since I wasted my time reading it instead of looking for a better resource. I would suggest you check out the Smarty template eninge's docs for what helpful docs look like.
Reply With Quote
  #5  
Old 26 Dec 2009, 21:14
Antivirus's Avatar
Antivirus Antivirus is offline
 
Join Date: Sep 2004
Thanks Marco for taking the time to write this for us. I found it quite helpful.
__________________
Please feel free to PM me about custom work, installations, and upgrades!

Eclipse Records - Streetcult Street Team
Reply With Quote
  #6  
Old 26 Dec 2009, 22:25
Trek Trek is offline
 
Join Date: Sep 2003
Originally Posted by ragarcia87 View Post
Has to be the worst template documentation ever. Basically this doc is a waste of time since there is soo little information in it. Not helpful what so ever, more of a hindrance since I wasted my time reading it instead of looking for a better resource. I would suggest you check out the Smarty template eninge's docs for what helpful docs look like.
Feel free to write better documentation once you know what you're doing since you already know what good documentation is.

In the meantime, I found this helpful, thank you for writing it.
Reply With Quote
  #7  
Old 27 Dec 2009, 01:53
ragarcia87's Avatar
ragarcia87 ragarcia87 is offline
 
Join Date: Jun 2009
Real name: Ryn Garcia
Originally Posted by Trek View Post
Feel free to write better documentation once you know what you're doing since you already know what good documentation is.

In the meantime, I found this helpful, thank you for writing it.
Yea I would write helpful documention if they paid me, everyone here seems to forget this software costs money and has mabye 4 offical plugin + template docs released for a new plugin + template system compared to the likes of wordpress which is free and has more info than the average person will be able to take in.

{vb:urlencode variable}
Yet no mention of what format the variable is to be used, is it the $variable or is it just variable.

{vb:if condition, true[, false]}
No defination of the syntax for a condition, nor defination of what the out for true can be or how to format it. Same goes for

<vb:if condition="condition">true result</vb:if>
which I personnally have extreme trouble getting to work, tried "$array.value='text'","array.text=text","$array.value==text",etc basically every way possible to try and get it to work and constantly it fails and which documention like this to fall back on it's a joke. If this was a user submitted documention it wouldn't bother me but it's offical documention and one of the few offical documention I could find, hell http://www.vbulletin.com/docs/ doesn't even have version 4 docs there. The only thing that eases my pain on this subject is knowing it wasn't me that paid for the license.
Reply With Quote
  #8  
Old 23 May 2010, 20:57
mbreezy mbreezy is offline
 
Join Date: Feb 2007
I've tried multiple ways, but cannot seem to get it to output at all.

I'm trying to get some of the site stats variables from here to display, but to no avail.

I've tried a few ways...

Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

Which combo is going to work?

Thanks
Reply With Quote
  #9  
Old 23 May 2010, 22:08
cellarius's Avatar
cellarius cellarius is offline
 
Join Date: Aug 2005
Real name: Sven
1 or 3, depending on what's in the variable. But I doubt that that variable is available in globally, so you'd probably make a plugin to fill it and register it for the template you want to use it in.
__________________
Please note that there will be no further updates to my addons, especially they will not be upgraded for vB5. I'm leaving vB, since IB choose to go the banana-way yet again.

http://www.roma-antiqua.de
Reply With Quote
  #10  
Old 24 May 2010, 01:33
mbreezy mbreezy is offline
 
Join Date: Feb 2007
Oh, okay. But I thought the variables listed in the vBulletin variable list (http://www.vbulletin.org/forum/showthread.php?t=179930) were global.
Reply With Quote
  #11  
Old 24 May 2010, 08:23
cellarius's Avatar
cellarius cellarius is offline
 
Join Date: Aug 2005
Real name: Sven
No, the site statistics variables were never globally available in vB3, plus: you're using vB4, as it seems, and there have been some significant changes on what is available where.
__________________
Please note that there will be no further updates to my addons, especially they will not be upgraded for vB5. I'm leaving vB, since IB choose to go the banana-way yet again.

http://www.roma-antiqua.de
Reply With Quote
  #12  
Old 29 May 2011, 20:03
SiteTalkZone SiteTalkZone is offline
 
Join Date: Dec 2008
While studying vb code is quite challenging and fun but at the same time this forum or vb itself is pathetic. Almost zero docs even for paying members. Woot!
Reply With Quote
Reply



Currently Active Users Viewing This Thread: 1 (0 members and 1 guests)
 
Article Options

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off


New To Site? Need Help?

All times are GMT. The time now is 18:35.

Layout Options | Width: Wide Color: