Go Back   vb.org Archive > vBulletin Article Depository > Read An Article > vBulletin 3 Articles
Reload this Page [vBulletin|PHP|HTML]Automatic Template Edits
FAQ Members List Calendar Search Today's Posts Mark Forums Read

Reply
Page 2 of 3 1 2 3
 
Thread Tools
[vBulletin|PHP|HTML]Automatic Template Edits
Ziki's Avatar
Ziki
Join Date: Nov 2005
Posts: 2,704

It appears that I am still alive

Show Printable Version Email this Page Subscription
Ziki Ziki is offline 08-27-2006, 10:00 PM
You are creating a new vBulletin product and want to make it more user friendly so that the users don't have to edit the templates manually?Then this tutorial will point you the right way.Basically the code I am going to demonstrate simply finds a specific part of a template and inserts our code/template into it.

Ok let's say you have a template or a piece of html code you want to include somewhere:

HTML Code:
<em>My name is $name and welcome to $board</em>
Ok now we have to options:

1. Insert the code into a template and then insert the whole template into the site.

So you now have the html code in your template called TEMPLATE.I suggest you cache it for faster loading.To do that create a new plugin on the cache_templates hook with this content:

PHP Code:
$globaltemplates  = array_merge($globaltemplates, array('TEMPLATE', 'TEMPLATE2')); 
$globaltemplates variable are the templates that are supposed to be cached.It is an array because it contains multiple templates,default ones and the ones from other 3rd party products.

So now what we just need to do,is insert our template into another one.To do that you need to know what page you want to display it on,the hooks that are located on that page and the templates called.In the template you will add the code in find a block of code that is static,thus won't ever be changed (like html comments).Should be one liner.Our template is TEMPLATE and the one that will include it is MAINTEMPLATE.

Then use this phpcode.

PHP Code:
$variable = 'OUR STATIC CODE';
$vbulletin->templatecache['MAINTEMPLATE'] = str_replace($variable,$variable.fetch_template('TEMPLATE'),$vbulletin->templatecache['MAINTEMPLATE'])
;]=]=> 
Explanation: the template MAINTEMPLATE is represented by the variable $vbulletin->templatecache['MAINTEMPLATE'].So we changed the way it is represented.We used str_replace to change the MAINTEMPLATE,so now it added the TEMPLATE into it.It searched for $variable and attached the template into it.

To include a code on every page use the hook global_start and the template header,footer or headinclude

DONE




2. Insert the code into a variable and insert it via replace.

Ok this is a bit easier than the code above.So we still want to add the code but don't want a template?Make the code into a variable.

PHP Code:
$template = '<em>My name is $name and welcome to $board</em>'; 
we used ' apostrophes instead of " so that the code isn't parsed directly in the variable but rather in the template.Note,if you have ' or " in your code,you have to put \ before them so that php doesn't think it belongs into the main code.

Then just use the code before.


PHP Code:
$template = '<em>My name is $name and welcome to $board</em>';
$variable = 'OUR STATIC CODE';
$vbulletin->templatecache['MAINTEMPLATE'] = str_replace($variable,$variable.$template,$vbulletin->templatecache['MAINTEMPLATE'])
;]=]=> 
DONE


3. Insert the code into a variable and call the variable in the template.

This is the easiest way.So we have $template already specified and we just put the variable ($template) into any template and vBulletin will parse it .But you have to make sure that the hook the variable is on,is called on that page!
DONE


4. Attach code to an existing variable in the template.
This method became easier when vBulletin introduced template hooks. For instance,open template navbar and you can find $template_hook['navbar_buttons_left'] somewhere in the code,thanks to which you can add new navbar buttons simply using plugins.To do that,I make a new plugin on global_setup_complete (or any plugin called where the variable is) and add this code:

PHP Code:
$template_hook['navbar_buttons_left'] .= '<td class="vbmenu_control"><a href="file.php' . $session['sessionurl_q'] . '" accesskey="5" >' . $vbphrase['mynewbutton'] . '</a></td>'; 
See the ".=" ?That means that the code following it was added to the variable's value and thus displayed when the variable is parsed .

You can also attach a whole template this way.In the next example I added my template below navbar.

PHP Code:
eval('$navbar .= "' . fetch_template('mytemplate') . '";'); 
DONE

I hope this article has helped you understand this topic and develop better and more user friendly products!
Reply With Quote
  #12  
Old 10-12-2006, 07:48 PM
Zachery's Avatar
Zachery Zachery is offline
 
Join Date: Jul 2002
Location: Ontario, Canada
Posts: 11,440
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default
Making your end users do less and less creates the problems we have now. Make your users do the template edits.
Reply With Quote
  #13  
Old 11-02-2006, 02:13 PM
Luggruff's Avatar
Luggruff Luggruff is offline
 
Join Date: Apr 2005
Posts: 239
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default
Quote:
Originally Posted by Ziki
??????
As Zachery said:

I for one have a hack (CYB - Forum Rules) and he has done this, He have placed the link to the forumrules in my navbar, and I can't change it, or the location of it.

Think that's fun when you want to make a custom style? For one: If I change my navbar to the header, that link does not follow.. and so on.

Bad, bad, bad bad bad bad bad bad.
Reply With Quote
  #14  
Old 11-02-2006, 05:40 PM
Paul M's Avatar
Paul M Paul M is offline
 
Join Date: Sep 2004
Location: Nottingham, UK
Posts: 23,748
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default
Whether you like automatic editing of templates is a personal choice, not a fact. If you want to discuss the merits of doing it please start a new thread, not clutter up this one.
Reply With Quote
  #15  
Old 11-03-2006, 05:35 PM
Ziki's Avatar
Ziki Ziki is offline
 
Join Date: Nov 2005
Posts: 2,704
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default
Quote:
Originally Posted by Paul M
Whether you like automatic editing of templates is a personal choice, not a fact. If you want to discuss the merits of doing it please start a new thread, not clutter up this one.
That was a plus for me?
Reply With Quote
  #16  
Old 11-11-2006, 07:50 PM
RedTyger's Avatar
RedTyger RedTyger is offline
 
Join Date: Nov 2006
Location: UK
Posts: 1,310
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default
Nicely done Ziki. And as an extra bonus, something I just found out. Namely that you don't need to create or insert a template if all you want to insert is one value from your settings.

Code:
$str = 'findthis';
$vbulletin->templatecache['footer'] = str_replace($str,$str.$vbulletin->options['kerjigger'],$vbulletin->templatecache['footer']);
Because str_replace uses up a little bit of resources, if whether or not it's going to be used is dependent on settings in your plugin then it's worth surrounding the replace code with a variable to ensure it only runs when it has to. Like so:

Code:
if ($vbulletin->options['mysetting'])
{
$str = 'findthis';
$vbulletin->templatecache['footer'] = str_replace($str,$str.$vbulletin->options['kerjigger'],$vbulletin->templatecache['footer']);
}
Reply With Quote
  #17  
Old 03-10-2007, 08:25 AM
RedTyger's Avatar
RedTyger RedTyger is offline
 
Join Date: Nov 2006
Location: UK
Posts: 1,310
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default
Two small additional notes.

Firstly, templatecache identities are CASE SENSITIVE. So $vbulletin->templatecache['SHOWTHREAD'] will work but $vbulletin->templatecache['showthread'] will not, because the the template is named with capitals.

Secondly, if you are doing a find/replace it's slightly more efficient to include what you're finding in the replacement text instead of appending it in the str_replace. So

Code:
$find = 'this';
$replace = 'this that';
$vbulletin->templatecache['SHOWTHREAD'] = str_replace($find, $replace, $vbulletin->templatecache['SHOWTHREAD']);
is more efficient than

Code:
$find = 'this';
$replace = ' that';
$vbulletin->templatecache['SHOWTHREAD'] = str_replace($find, $find.$replace, $vbulletin->templatecache['SHOWTHREAD']);
Doing it the first way also has another advantage in that you can add your replacement immediately before what you're finding. If you do it the second way, you can only add it after.
Reply With Quote
  #18  
Old 03-10-2007, 08:43 AM
ragtek ragtek is offline
 
Join Date: Mar 2006
Location: austria, croatia
Posts: 1,630
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default
there is a very nice product from andreas http://www.vbhacks-germany.org/showthread.php?t=5572
Reply With Quote
  #19  
Old 04-02-2007, 12:43 PM
Luky Luky is offline
 
Join Date: Oct 2006
Location: Australia
Posts: 595
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default
Didnt read, but ALL mods should use this! :P I hate editing templates for mods, it means you gota do it for every style, i have alot of styles =/
Reply With Quote
  #20  
Old 09-26-2008, 08:44 PM
Ziki's Avatar
Ziki Ziki is offline
 
Join Date: Nov 2005
Posts: 2,704
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default
Article was updated.
Reply With Quote
  #21  
Old 05-16-2009, 06:13 AM
Ziki's Avatar
Ziki Ziki is offline
 
Join Date: Nov 2005
Posts: 2,704
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default
Updated
Reply With Quote
Reply
Page 2 of 3 1 2 3

« Previous Thread | Next Thread »
Thread Tools

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
Forum Jump


All times are GMT. The time now is 06:40 PM.

Contact Us - Archive - Top

Powered by vBulletin® Version 3.8.12 by vBS
Copyright ©2000 - 2024, vBulletin Solutions Inc.
X vBulletin 3.8.12 by vBS Debug Information
  • Page Generation 0.06690 seconds
  • Memory Usage 2,321KB
  • Queries Executed 25 (?)
More Information
Template Usage:
  • (1)SHOWTHREAD
  • (1)ad_footer_end
  • (1)ad_footer_start
  • (1)ad_header_end
  • (1)ad_header_logo
  • (1)ad_navbar_below
  • (1)ad_showthread_beforeqr
  • (4)bbcode_code
  • (1)bbcode_html
  • (6)bbcode_php
  • (2)bbcode_quote
  • (1)footer
  • (1)forumjump
  • (1)forumrules
  • (1)gobutton
  • (1)header
  • (1)headinclude
  • (1)modsystem_article
  • (1)navbar
  • (4)navbar_link
  • (120)option
  • (1)pagenav
  • (1)pagenav_curpage
  • (2)pagenav_pagelink
  • (11)post_thanks_box
  • (11)post_thanks_button
  • (1)post_thanks_javascript
  • (1)post_thanks_navbar_search
  • (11)post_thanks_postbit_info
  • (10)postbit
  • (11)postbit_onlinestatus
  • (11)postbit_wrapper
  • (1)spacer_close
  • (1)spacer_open
  • (1)tagbit_wrapper 
Phrase Groups Available:
  • global
  • inlinemod
  • postbit
  • posting
  • reputationlevel
  • showthread
Included Files:
  • ./showthread.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/functions_bigthree.php
  • ./includes/class_postbit.php
  • ./includes/class_bbcode.php
  • ./includes/functions_reputation.php
  • ./includes/functions_post_thanks.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
  • showthread_start
  • showthread_getinfo
  • forumjump
  • showthread_post_start
  • showthread_query_postids
  • showthread_query
  • bbcode_fetch_tags
  • bbcode_create
  • showthread_postbit_create
  • postbit_factory
  • postbit_display_start
  • post_thanks_function_post_thanks_off_start
  • post_thanks_function_post_thanks_off_end
  • post_thanks_function_fetch_thanks_start
  • post_thanks_function_fetch_thanks_end
  • post_thanks_function_thanked_already_start
  • post_thanks_function_thanked_already_end
  • fetch_musername
  • postbit_imicons
  • bbcode_parse_start
  • bbcode_parse_complete_precache
  • bbcode_parse_complete
  • postbit_display_complete
  • post_thanks_function_can_thank_this_post_start
  • pagenav_page
  • pagenav_complete
  • tag_fetchbit_complete
  • forumrules
  • navbits
  • navbits_complete
  • showthread_complete