The Arcive of Official vBulletin Modifications Site.It is not a VB3 engine, just a parsed copy! |
|
First Look at vBulletin 4 Template Tags
Reposted from my site at www.vbcodex.com Following my previous article, I want to give some information about the new template tags in vBulletin 4. The use of template tags is not a new concept to vBulletin 4 developers and designers. We have been using them for years for conditional statements and building phrases that had parameters. In vBulletin 4, Phrase parsing has been moved to the variable parsing system but conditional usage has been improved and several new tags have been added to make things easier. Like the variable system I talked about earlier, tags are in their own namespace so all tags are prefixed with 'vb:'. This actually provides several benefits but the primary one is that you can program scriptable web editors like Dreamweaver or Expressions Web to parse these conditionals and provide output based on values you provide. They also allow proper syntax highlighting to occur in most web editors. Template Conditionals Everyone who has worked with vBulletin templates in the past should be familiar with template conditionals. They provide a wide range of use in determining what information to show depending on various conditions. In vBulletin 3.X, the IF conditional was simple and easy to use. In fact, you can still use pretty much the same format in vBulletin 4. However a couple of new tags were added to make conditionals more robust. Here is an example: HTML Code:
<vb:if condition="$show['guest']"> <div class="alert">You are a guest, no soup for you.</div> <vb:elseif condition="$is_member_of($bbuserinfo,6)" /> <div class="adminalert">Hello {vb:raw bbuserinfo.musername}! Let's get to work.</div> <vb:else /> <div class="useralert">Welcome Back {vb:raw bbuserinfo.musername}!</div> </vb:if> Conditionals also have a new shorthand using a curly brace syntax. In today's templates, you see a lot of code that looks like this: HTML Code:
<a href="somepage.php<if condition="$album['albumid']">album=$album[albumid]<else />group=$group[groupid]</if>">link text</a> HTML Code:
<a href="somepage.php{vb:if $album['albumid'] : album=$album[albumid] ? group=$group[groupid]}">link text</a> Each For a long time, users have wanted a way to do loops in templates. Heck, I have wanted to be able to do loops in templates. vBulletin 4.0 includes the <vb:each> tag which accomplishes just that. While it is not being used for the default templates at this time, it will probably be used in the future to eliminate some of the many 'bit' templates in the system. The Each tag will allow you to easily process an array and apply formatting to its elements. Example: HTML Code:
Welcome this week's new users: <ul> <vb:each from="newusers" key="userid" value="newuserinfo"> <li><a href="member.php?u={vb:var userid}">{vb:var newuserinfo.username}</a></li> </vb:each></ul> PHP Code:
Code:
Welcome this week's new users: Adam Ben Chris Comment How many times have you wanted to leave commented notes in a template so you can understand why you did what you did? Or you work on a team so others need to know what is being done in a template? Before now, you would have had to use HTML comments that would have been output to the Browser and visible in the page's source code. vBulletin 4.0 introduces the comment tag so you can add your comments and not worry about them being sent to the client. Comments will be stripped when the template is compiled into PHP. Can also be used for hiding code blocks from being output to the user. Example: HTML Code:
<vb:comment>This is a comment and won't be shown in page source code.</vb:comment> Literals The final new tag is the literal tag. It allows you to stop the parsing of any nested tags or variable syntax within the tags. It works similar to the noparse BB Code. It is handy when you want the template to simply output the raw HTML instead of putting it through the template parser. Example: HTML Code:
<vb:literal>This will output exactly like this {vb:raw somevariable}</vb:literal> Summary While the changes to tags are not as extensive as variable handling, the new tags provide new ways of handling templates and will provide better abilities to create addon products in the future. The Each and Comment tags will come in especially handy while doing customizations in the future. I hope this gives you another good glimpse into the vBulletin 4.0 template system. |
#12
|
|||
|
|||
Thank you, Wayne!
This actually looks a lot easier and better than the old system, and seems more logical, too. |
#13
|
||||
|
||||
vB4 as come a long way with coding. Much appreciated Wayne!
|
#14
|
||||
|
||||
I think it became more complicated !
|
#15
|
||||
|
||||
Not all that different. Very helpful. I do like the comment options though very much.
TY |
#16
|
|||
|
|||
Thank you :up:
|
#17
|
||||
|
||||
Makes sense -- off hand, anyone know if <vb:comment> show up in the html source code when vb is in debug mode?
|
#18
|
||||
|
||||
have anybody try to use
PHP Code:
|
#19
|
||||
|
||||
It isn't $is_member_of, it's simply is_member_of (no $ in front).
|
#20
|
|||
|
|||
Something to be aware of with the conditional tag.
Whereas in vb3.x, fetch_template was typically eval()'d in the scope of the function that created the template output, in vb4, the template is eval()'d inside another function. Since the conditional test refers to standard php variables rather than the vb registered template variables, this can create a situation where the variable you are testing is not in scope, so the test will always fail. For example: PHP Code:
PHP Code:
You can get round this by explicitly referring to the registered variable in the vb:if condition as follows: PHP Code:
|
#21
|
||||
|
||||
Thanks for posting that, Andrew. I haven't run into that problem yet, but I know I will and I'll be pulling my hair out and then I'll remember this post of yours and the world will be right again.
|
|
|
X vBulletin 3.8.12 by vBS Debug Information | |
---|---|
|
|
More Information | |
Template Usage:
Phrase Groups Available:
|
Included Files:
Hooks Called:
|