vb.org Archive - Template Editing - All the variables and coding bits you need to know!

vb.org Archive (https://vborg.vbsupport.ru/index.php)

- Programming Articles (https://vborg.vbsupport.ru/forumdisplay.php?f=188)

- - Template Editing - All the variables and coding bits you need to know! (https://vborg.vbsupport.ru/showthread.php?t=113489)

Template Editing - All the variables and coding bits you need to know!

TEMPLATE EDITING, USEFUL VARIABLES, AND CODE SNIPPETS

Hi everyone,

While doing a hunt on vb.org for a list of the main vbulletin variables that I would need to output certain values in custom templates I was making, my search resulted in a huge lack of information so I decided to put together a list that will hopefully help any vbulletin coding beginner that wants to create a custom template and output certain information:

EDITING TEMPLATES
To begin to understand what these variables and code snippets are for, you first need to know how to edit a template in the first place. It is very easy and VBulletin makes it as simple as possible to do so. Here are a few tips to get you started:

1) Login to your ADMINCP (www.yoursite.com/admincp)
2) Click STYLES & TEMPLATES on the left
3) Click STYLE MANAGER

You are now seeing a list of all of the styles/themes you have on your vbulletin forum. By default you'll have "Default Style" which is VBulletin's style that comes with the out-of-box system.

4) Click the "ALL STYLES OPTION" dropdown. You will now see a list of options you can do to your default style. A few to note are:

- Edit Templates
- Add New Template
- Add Child Style
- Delete Style

5) We are going to click on EDIT TEMPLATES and then click the GO button (if the page has not refreshed already to the edit templates area).

You will now see a list of templates and headers with a scroll bar to scroll through them all. A few templates and headers to note are:

- footer
- Forum Display Templates
- Forum Home Templates
- header
- Navigation / Breadcrumb Templates

These will be the ones you will edit most commonly. To edit a template, simply double click on its name. If you double-click on a blue header, it will dropdown the sub-templates that are under that header. For example, "Forum Home Templates", when double-clicked, will show "FORUMHOME" as a sub-template under that header.

For this tutorial we are going to just focus on the "header" template. So go ahead and double click it to begin.

USEFUL VARIABLES

Ok, so lets go over some very useful variables that you can use in your templates. Once you have opened the "header" template in the previous step, try typing in some of these variables to see what they output in your forum:

1. $vboptions[bburl] - This variable outputs the url to your forum which you have set in your VBulletin general options. This is useful to use this instead of hardcoding in your website URL because in the future you may want to change your domain and don't want to have to search through your dozens of templates for where you hardcoded in the domain at the beginning.

2. $vboptions[bbtitle] - Outputs the title of your forum which is set in the general VBulletion options.

3. $bbuserinfo[username] - Very useful, this variable will output the username/nickname of the user currently logged in.

4. $headinclude - Used to output the header template

5. $vboptions[bburl]/usercp.php$session[sessionurl_q] - Useful url which will link to the USERCP for the user

6. $vboptions[bburl]/login.php?$session[sessionurl]do=logout&u=$bbuserinfo[userid] - Useful url which will log off the user when clicked

7. <phrase 1="$pmbox[lastvisitdate]" 2="$pmbox[lastvisittime]">$vbphrase[last_visited_x_at_y]</phrase> - This will show the last time the user logged into the forum. For example: You last visited: Today at 07:57 PM

8. $vboptions[bburl]/private.php? - URL to load the user's PM mailbox

9. $bbuserinfo[pmunread] - Will output how many unread PM's the user has

10. $bbuserinfo['field#'] - Will output the data that the user inputted for their user profile field which you can set up. Replace # with the number of the input field you want to display

11. $bbuserinfo['posts'] - Shows how many posts the user has

Have a variable to add to this list? Create a reply and I'll add it!

CODE SNIPPETS

Ok, now I'll show you some code snippets that are particularly useful for custom templates. Most of these code snippets use the variables above.

1. Show if logged in user has new mail or not

Code:

Mailbox: <if condition="$bbuserinfo['pmunread']">

<b><a href="$vboptions[bburl]/private.php?"><font face="Verdana" size="1" color="#78818D"> <img src="blink_arrow.gif" width="3" height="6" border="0">$bbuserinfo[pmunread] new message(s)</b>.</font></a><else />No new messages.</if>

The parts to focus on here are:
a. <if condition="$bbuserinfo['pmunread']">
b. $bbuserinfo[pmunread] new message(s)
c. <else />No new messages.</if>

What this code snippet does is check if the user has new PM messages. If the user does, it outputs a message say he has x new message(s) and puts an animated graphic to attract attention. If the user doesn't have any messages, it simply outputs "No new messages".

2. Conditional output based on user fields
For this code snippet, you will need to have set up some user profile fields that you can use. To edit or create new ones, in your ADMINCP go to "User Profile Fields" and click "User Profile Field Manager".

Code:

<if condition="$bbuserinfo['field7']=='Paid Member' OR $bbuserinfo['field7']=='Trial Member'>Output paid member only stuff here</if>

What you would use this for is if you create a new profile field and call it "member status". When the user registers you can set this to automatically give them "Free Member" status, and this input fills in with the text "Free Member". Then, if they pay you, you can login and edit their profile so that this input says the text "Paid Member" or "Trial Member", in which case this code will output special stuff for them. You could also use usergroup's instead of profile fields for this. If you want to do that then use:

Code:

<if condition="is_member_of($bbuserinfo, 6)">

Ooo, you're an admin. You get this special content here.

</if>

And if you want multiple groups to be able to access the content:

Code:

<if condition="is_member_of($bbuserinfo, 4) // Mods 

        OR is_member_of($bbuserinfo, 5) // Supermods 

        OR is_member_of($bbuserinfo, 6)"> // Admin



Insert the special content here.

</if>

3. Annoy users who haven't posted
Well, as most people know, users sometimes signup just to read posts and never post any new ones or contribute to your community. To bug them to post you can use this code snippet:

Code:

<if condition="$bbuserinfo['posts']==0">

You haven't posted any new posts yet! Get posting and help to build this amazing community! :-)

</if>

4. Custom login box
Want to put a login box to your forum somewhere on a template? Try this:

Code:

<!-- login form -->

                <form action="$vboptions[bburl]/login.php" method="post" onsubmit="md5hash(vb_login_password,vb_login_md5password)">

                <script type="text/javascript" src="$vboptions[abspath]/clientscript/vbulletin_md5.js"></script>

                <table cellpadding="0" cellspacing="$stylevar[formspacer]" border="0">

                <tr>

                        <td class="smallfont" width="60"><font size="1" face="Tahoma" color="#FFFFFF">&nbsp;User Name:</font></td>

                        <td><input type="text" class="button" name="vb_login_username" id="navbar_username" size="10" accesskey="u" tabindex="1" value="$vbphrase[username]" onfocus="if (this.value == '$vbphrase[username]') this.value = '';" /></td>

                        <td class="smallfont" width="100"><font size="1" face="Tahoma" color="#FFFFFF">Password:

              (</font><a href="login.php?do=lostpw"><font size="1" face="Tahoma" color="#FFFFFF">forgot?</font></a><font size="1" face="Tahoma" color="#FFFFFF">)</font></td>

                        <td><input type="password" class="button" name="vb_login_password" size="10" accesskey="p" tabindex="2" /></td>

                        <td><input type="submit" class="button" value="$vbphrase[log_in]" tabindex="4" title="$vbphrase[enter_username_to_login_or_register]" accesskey="s" /></td>

                </tr>

                </table>

                <input type="hidden" name="s" value="$session[sessionhash]" />

                <input type="hidden" name="do" value="login" />

                <input type="hidden" name="forceredirect" value="1" />                        

                <input type="hidden" name="vb_login_md5password" />

                </form>

                <!-- / login form -->

So there you have it, some tips to get you started. Goodluck and happy template customizing!

----
Chad Fullerton
www.chadfullerton.com

You can access information in objects directly with the templates. For example this:

HTML Code:

$bbuserinfo[username]

Can be written as:

HTML Code:

{$vbulletin->userinfo['username']}

Thanks, that login code really helped me, great post!

Quote:

Originally Posted by Zero767

Thanks, that login code really helped me, great post!

No problem Zero767 :) Glad it helped!

Quote:

Originally Posted by toolblast

And if you want multiple groups to be able to access the content:

Code:

<if condition="is_member_of($bbuserinfo, 4) // Mods 

        OR is_member_of($bbuserinfo, 5) // Supermods 

        OR is_member_of($bbuserinfo, 6)"> // Admin



Insert the special content here.

</if>

is_member_of can be overloaded, a shorter version of the above could be:

Code:

is_member_of($bbuserinfo, array(5, 6, 7))

BTW, group 7 is mods, not group 4.

Thanks Bairy!

Yes, it is probably best to use the code you provided for the usergroup detection, it is faster and more effective.

Wow! This really explained a lot to me! Thanks for posting this!

Excellent tutorial! I needed to figure out a few things and this answered almost every one of my questions!!! :D

How do I do it if I want to have the login on a different homepage?

Thanks FLMom and Pro for the kind words. I am glad this has helped you.

Quote:

How do I do it if I want to have the login on a different homepage?

All you gotta do Chipet is copy the code and place it into an html or php file on your server (doesnt have to be in the forum folder), and then just make sure where it says "action="$vboptions[bburl]/login.php" erase the $vboptions[bburl]/ and replace it with the path to your forum.

So it would be something like:

Quote:

<form action="http://www.mysite.com/forum/login.php"...

Quote:

Originally Posted by Brad

You can access information in objects directly with the templates. For example this:

HTML Code:

$bbuserinfo[username]

Can be written as:

HTML Code:

{$vbulletin->userinfo['username']}

It doesn't seem to like that in if condition = statements, though. ;)

Hm. when I laying the code on a different homepage it doen't login when I try login, Im just being redirected to the forum without being loged in.

Quote:

Originally Posted by Boofo

It doesn't seem to like that in if condition = statements, though. ;)

In these places simpy drop the brackets :)

Quote:

Originally Posted by Brad

In these places simpy drop the brackets :)

In a condition, would that be the same as <if condition="$show['member']">?

Conditions are executed like so:

Code:

blah blah<if condition="$var">eggnog<else />cheese</if>blahblah

Code:

blah blah" . (($var) ? "eggnog" : "cheese") . "blahblah

Because they aren't parsed through double quotes like the rest, there is no need for the braces. I always use the full object vars in conditions, though the shorthand versions appear to work fine as well.

@Boofo: looking at global.php lines 431 (for me anyway):

PHP Code:


		
			
if ($vbulletin->userinfo['userid'])

{

    $show['guest'] = false;

    $show['member'] = true;

}

else

{

    $show['guest'] = true;

    $show['member'] = false;

}

so to answer your question: yes. It's probably "best" to use $show variables in templates as much as possible, because it keeps the application logic seperate from your templates, but for things as simple as that it shouldn't really matter.

Interesting. Thanks for sharing that SirAdrian, it is always best as a programmer to keep things as clear to look at and logical, I like the if statement format you showed.

Thanks this is great!

hooooooo tnx bro nice writing

Thanks for a great post and thanks to the other members/staff that have contributed, this will come in really handy for e when i create new page that im working on, Just out of interest, i take it these variables will work within something like Logicans Web Templates? I am sure it will but i just want to make sure? :)

ı did new user fields
how can ı showing new page first members new fields

So how is it, and where is it you add background images instead of just colors?

So far this has helped me alot.

Thanks to everyone for your support with this thread. I appreciate your kind words.

@Bashy: I'm not sure what Logicians's templates are.. I haven't used them myself. But I assume it would work if the templates integrate with the vbulletin scripting structure

@Genchacker: I'm not sure what exactly you're trying to do. Please elaborate in more detail.

@5IVEO:

To add background images in templates you just use the standard HTML code for tables and bgimage, etc. or css background image.

If you're wanting to put images in your templates, you can go into admincp and for 'background' for any of those style bits you can use something like "url(images/gradients/gradient_tcat.gif) repeat-x top left".

Quote:

4. $headerinclude - Very useful, this variable will output the username/nickname of the user currently logged in.

Two errors here... one is obvious (copy pasted from line above it), second is that it's $headinclude (not head"er").

Sorry. It is now 'headinclude' instead of 'header'

$headinclude contains the 'headinclude' template, not the current username...

Ya, there were duplicate descriptions for some reason. Fixed it now :) Thanks!!

what if wana use a custom variable in php file to include in a template ?

for example :
if I write in postings.php :

PHP Code:


		
			
$linkurl_img = "";

can I use this variable directly in any template ?

Variables you want to be able to use in any template need to be defined globally on vbulletin...

Some urls that may help:
link 1, link 2, link 3

Quote:

Originally Posted by toolblast

Thanks for the help I greatly appreciate it! Now I can work on making my own theme.

Quote:

Originally Posted by toolblast

Variables you want to be able to use in any template need to be defined globally on vbulletin...

Some urls that may help:
link 1, link 2, link 3

thank you. I will read these pages :) .

Thanks!
I thought nothing in here would be useful to me but those IF conditions really helped me out.
Cheers! ^_^

Glad this thread has been helpful to people :D

Hi all,

What are the variables available in the $foruminfo[] array? I'm looking to linkify the forum description box, so the name of the forum links to the forum.

TIA!

thanks for sharing.
really help me a total newbie get started.
this should incl in the manuals.

i have one doubts .
normally we add standard css inline.

how do i direct the template to external css? and which file in edit in this?
can the standard import command be used ?

thanks

Hi everyone!

Thanks for reading this thread and I hope you found it helpful. I'm currently putting together an ebook to help people get started with customizing vbulletin with their own pages and products/plugins. Step by step instructions (with screenshots) on how to create your very first custom product (introduction to custom php files, plugins, hooks, style templates, integrating user information, etc), as well as tips, tricks, and code snippets that you can use to get some commonly asked things done... and all in simple to understand english ;)

If interested, shoot me a private message.

Customizing vBulletin can be fun! Let us show you how :)

Update:In the meantime, be sure to check out vb.org's articles section, and the vBulletin Manual.

You have $vbulletin->userinfo['username']. Where is $bbuserinfo['field6'] via the function call?

This is good stuff. I do have a question that isn't covered.

Say I have a multiple choice custom user profile field that is stored bitwise in the database.

Example:

Choice 1 = 1
Choice 2 = 2
Choice 3 = 4
Choice 4 = 8
Choice 5 = 16

So if a user selected choices 4 and 5, the stored value would be 24.

How could I evaluate this easily with an If/Then statement so that I could display the appropriate icons under the username in the postbit based upon each choice.

For example, the for the user above it would need to display two icons that correspond to choices 4 and 5.

If an user had selected ALL fields, the value would be 31, and it would need to display 5 icons.

I've done plenty of the <if condition="is_member_of($post, X)"> logic when it comes to usergroup membership, but this bitwise storage is confusing.

Can anyone show me a quick sample that would help clear this up for me?

Edit: I figured it out. Here's the answer for anyone looking for it:

Code:

<if condition="$post[field11] & 2">

<div><img src="images/badge2.gif"></div>

</if>

<if condition="$post[field11] & 4">

<div><img src="images/badge3.gif"></div>

</if>

this thread helps so much
what about that ebook?

Phrase Groups Available:

X vBulletin 3.8.12 by vBS Debug Information
Page Generation 0.01467 seconds Memory Usage 1,863KB Queries Executed 10 (?)
More Information
Template Usage: (1)ad_footer_end (1)ad_footer_start (1)ad_header_end (1)ad_header_logo (1)ad_navbar_below (11)bbcode_code_printable (4)bbcode_html_printable (2)bbcode_php_printable (10)bbcode_quote_printable (1)footer (1)gobutton (1)header (1)headinclude (6)option (1)pagenav (1)pagenav_curpage (1)pagenav_pagelink (1)post_thanks_navbar_search (1)printthread (40)printthreadbit (1)spacer_close (1)spacer_open Phrase Groups Available: global postbit showthread	Included Files: ./printthread.php ./global.php ./includes/init.php ./includes/class_core.php ./includes/config.php ./includes/functions.php ./includes/class_hook.php ./includes/modsystem_functions.php ./includes/class_bbcode_alt.php ./includes/class_bbcode.php ./includes/functions_bigthree.php Hooks Called: init_startup init_startup_session_setup_start init_startup_session_setup_complete cache_permissions fetch_threadinfo_query fetch_threadinfo fetch_foruminfo style_fetch cache_templates global_start parse_templates global_setup_complete printthread_start pagenav_page pagenav_complete bbcode_fetch_tags bbcode_create bbcode_parse_start bbcode_parse_complete_precache bbcode_parse_complete printthread_post printthread_complete
Messages: