Go Back   vb.org Archive > vBulletin Article Depository > Read An Article > vBulletin 4 Articles

Reply
 
Thread Tools
[HOW TO - vB4] Create your own vBulletin page
Lynne's Avatar
Lynne
Join Date: Sep 2004
Posts: 41,180

 

California/Idaho
Show Printable Version Email this Page Subscription
Lynne Lynne is offline 11-15-2009, 10:00 PM

This is an updated article on how to create your own vbulletin powered page. It's only for use with vB4.

This is NOT my work. I'm posting this from another thread where vB Style took the time to write this out. And his work is based on the article by Gary King here - How to create your own vBulletin-powered page! (uses vB templates)

Instructions to Create your Own Page:


1. Create the php page:
- Create a new file, whatever you want to call it (let's say test.php).
- Open up test.php and add the following (replace TEST with whatever template you want to show - WARNING: the template name is CASE SENSITIVE!!!):
Code:
<?php

// ####################### SET PHP ENVIRONMENT ###########################
error_reporting(E_ALL & ~E_NOTICE);

// #################### DEFINE IMPORTANT CONSTANTS #######################

define('THIS_SCRIPT', 'test');
define('CSRF_PROTECTION', true);  
// change this depending on your filename

// ################### PRE-CACHE TEMPLATES AND DATA ######################
// get special phrase groups
$phrasegroups = array();

// get special data templates from the datastore
$specialtemplates = array();

// pre-cache templates used by all actions
$globaltemplates = array('TEST',
);

// pre-cache templates used by specific actions
$actiontemplates = array();

// ######################### REQUIRE BACK-END ############################
// if your page is outside of your normal vb forums directory, you should change directories by uncommenting the next line
// chdir ('/path/to/your/forums');
require_once('./global.php');

// #######################################################################
// ######################## START MAIN SCRIPT ############################
// #######################################################################

$navbits = construct_navbits(array('' => 'Test Page'));
$navbar = render_navbar_template($navbits);

// ###### YOUR CUSTOM CODE GOES HERE #####
$pagetitle = 'My Page Title';

// ###### NOW YOUR TEMPLATE IS BEING RENDERED ######

$templater = vB_Template::create('TEST');
$templater->register_page_templates();
$templater->register('navbar', $navbar);
$templater->register('pagetitle', $pagetitle);
print_output($templater->render());

?>
- Be sure to change 'TEST' to the actual template name (WARNING: the template name is CASE SENSITIVE!!!), and change 'test' to the filename or a unique name for the page. Also, change 'Test Page' and 'My Page Title' to whatever you want to show in the navbits, such as 'Viewing Member Profile' (just an example).

2. Create the Template:
- If you are in debug mode, create the template in your MASTER STYLE so it shows up in all your styles, otherwise make sure you create the template in the style you are using. If following the page above, call the template TEST (WARNING: the template name is CASE SENSITIVE!!!) with the following content:
HTML Code:
{vb:stylevar htmldoctype}
<html xmlns="http://www.w3.org/1999/xhtml" dir="{vb:stylevar textdirection}" lang="{vb:stylevar languagecode}" id="vbulletin_html">
  <head>
    <title>{vb:raw vboptions.bbtitle} - {vb:raw pagetitle}</title>
    {vb:raw headinclude}
    {vb:raw headinclude_bottom}
  </head>
  <body>
    
    {vb:raw header}
    
    {vb:raw navbar}
    
    <div id="pagetitle">
      <h1>{vb:raw pagetitle}</h1>
    </div>
    
    <h2 class="blockhead">Title</h2>
    <div class="blockbody">
      <div class="blockrow">
        Text
      </div>
    </div>
    
    {vb:raw footer}
  </body>
</html>
.
Instructions to Add your Page to the Who's Online List (WOL):
Create two plugins using the following hooks. Replace mypage and similar with your information.

1. hook location - online_location_process:
Code:
switch ($filename)
{
    case 'test.php':
        $userinfo['activity'] = 'mypage';
        break;
// add more cases here if you have more than one custom page. no need for multiple plugins. one plugin can handle all.
}
.
2. hook location online_location_unknown:
Code:
switch ($userinfo['activity'])
{
    case 'mypage':
        $userinfo['where'] = '<a href="test.php?'.$vbulletin->session->vars[sessionurl].'">My Page</a>';
        $userinfo['action'] = "Viewing My Page";
        $handled = true;
        break;
// add more cases here if you have more than one custom page. no need for multiple plugins. one plugin can handle all.
}
.
The colored part in the code above shows what you need to change in the plugins (both reds should be the same and both blues should be the same, whereas green can be whatever you want).


Please see this article for help with rendering templates - [vB4] Rendering templates and registering variables - a short guide
Reply With Quote
  #462  
Old 01-14-2011, 05:26 PM
rumas rumas is offline
 
Join Date: Jan 2007
Posts: 12
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default

Hello Lynne,
I used this thread to create a Google custom search results page and it works great.

However, my problem is I have Google adsense ads in the navbar and footer, how do I exclude the ads from the "search results page" as they are against Google terms of service?
Reply With Quote
  #463  
Old 01-15-2011, 03:37 AM
Lynne's Avatar
Lynne Lynne is offline
 
Join Date: Sep 2004
Location: California/Idaho
Posts: 41,180
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default

You would need to put a condition around the code in the ad to not show it on this page. (Use your definition of THIS__SCRIPT in the condition.)
Reply With Quote
  #464  
Old 01-16-2011, 09:08 AM
rumas rumas is offline
 
Join Date: Jan 2007
Posts: 12
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default

Thank you Lynne for helping me and everyone else with in this thread...

Here is the condition I used around the ad, works great. Maybe this will help someone else!

Code:
<vb:if condition="THIS_SCRIPT != 'Your_Definition'">

</vb:if>
Reply With Quote
  #465  
Old 01-16-2011, 01:20 PM
tonmo tonmo is offline
 
Join Date: Dec 2004
Posts: 31
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default

Hi Lynne - I'm wondering if you can help me. I have tons of pre-existing custom HTML (actually .php) pages, all which leverage a server-side include, let's call it header.php.

I'd like to replace the contents of header.php with something that would allow all of my pre-existing pages to automagically support my vbulletin header and navigation.

All these pages also reference a footer.php, if that is helpful to the cause (but that's easy enough for me to replicate, at least visually what is shown to the user).

--------------- Added [DATE]1295192670[/DATE] at [TIME]1295192670[/TIME] ---------------

Quote:
Originally Posted by rumas View Post
Thank you Lynne for helping me and everyone else with in this thread...

Here is the condition I used around the ad, works great. Maybe this will help someone else!

Code:
<vb:if condition="THIS_SCRIPT != 'Your_Definition'">

</vb:if>
I get an undefined error when trying to wrap this around my ad code via the Advertisements feature within AdminCP. Do you embed your ads manually?
Reply With Quote
  #466  
Old 01-16-2011, 05:10 PM
Lynne's Avatar
Lynne Lynne is offline
 
Join Date: Sep 2004
Location: California/Idaho
Posts: 41,180
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default

Sorry tonmo, but I don't understand your question at all. This is just a tutorial on how to make a single custom page. If you want to reference other scripts in the page, that is fine, but you need to write the code in those scripts and write the code in the php page. This isn't a tutorial on how to write your code.

As for the undefined error.... you need to change Your_Definition to a valid name or that isn't going to work.
Reply With Quote
  #467  
Old 01-16-2011, 05:36 PM
tonmo tonmo is offline
 
Join Date: Dec 2004
Posts: 31
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default

To clarify - I have dozens of static php pages that I created long before I implemented vBulletin. The page format is this:

HEADER
..
UNIQUE ARTICLE CONTENT
..
FOOTER

The HEADER and FOOTER are separate included files (i.e., header.php and footer.php); they are common across all article pages. I am wondering if there is any common vb4 code I can put into the header and footer files in order to wrap all of these articles into the vbulletin look and feel. I'm running 4.1.1.

Does that help explain what I'm trying to do?
Reply With Quote
  #468  
Old 01-16-2011, 06:27 PM
Lynne's Avatar
Lynne Lynne is offline
 
Join Date: Sep 2004
Location: California/Idaho
Posts: 41,180
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default

Quote:
Originally Posted by tonmo View Post
To clarify - I have dozens of static php pages that I created long before I implemented vBulletin. The page format is this:

HEADER
..
UNIQUE ARTICLE CONTENT
..
FOOTER

The HEADER and FOOTER are separate included files (i.e., header.php and footer.php); they are common across all article pages. I am wondering if there is any common vb4 code I can put into the header and footer files in order to wrap all of these articles into the vbulletin look and feel. I'm running 4.1.1.

Does that help explain what I'm trying to do?
Yes, that explains it better. I would guess you would want to assign the contents of those files to a variable and then spit them out into the template. I know I've seen the code posted around here to do that, but don't know it off the top of my head. (I think it's even posted in this thread somewhere.)
Reply With Quote
  #469  
Old 01-17-2011, 03:43 AM
TheInsaneManiac TheInsaneManiac is offline
 
Join Date: Feb 2008
Posts: 1,360
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default

Quote:
Originally Posted by Lynne View Post
Basically the same except you need to change all your eval/fetch_template statements to use the new syntax (the new syntax is covered in other articles, although shown in the code for this one).
Can you use an example.
Reply With Quote
  #470  
Old 01-17-2011, 01:00 PM
tonmo tonmo is offline
 
Join Date: Dec 2004
Posts: 31
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default

Quote:
Originally Posted by Lynne View Post
Yes, that explains it better. I would guess you would want to assign the contents of those files to a variable and then spit them out into the template. I know I've seen the code posted around here to do that, but don't know it off the top of my head. (I think it's even posted in this thread somewhere.)
Thanks - but probably not for me. I want each page to retain its own unique title and I don't believe your method would allow that.

All of my static pages exist in different places throughout my site, and have signifcant inbound links that I don't want to break. So far I've found two ways to convert them into vb pages:

1) Simply create new Article pages via CMS and copy/paste the original article contents into the new file. Convert the static page to a permanent redirect which points to the new CMS article.

2) Use the method described in this thread (How To Create Your Own vBulletin Page).

I'm finding both to be a bit labor-intensive (I have dozens of pages). Maybe 5 or 10 mins per article - those add up! Since all my static pages use server-side includes for the header and footer, I was hoping I could insert the logo, ad, and navbar at the top, and the footer at the bottom, so that I would only need to edit two files (the two includes) and viola! My site is converted. Seems that's not an option?
Reply With Quote
  #471  
Old 01-28-2011, 01:59 PM
fireglow305 fireglow305 is offline
 
Join Date: May 2010
Location: Germany / NRW
Posts: 16
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default

Good article, thank you.
Reply With Quote
Reply

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 02:29 AM.


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.08254 seconds
  • Memory Usage 2,369KB
  • Queries Executed 26 (?)
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
  • (5)bbcode_code
  • (1)bbcode_html
  • (4)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
  • (4)pagenav_pagelink
  • (3)pagenav_pagelinkrel
  • (11)post_thanks_box
  • (58)post_thanks_box_bit
  • (11)post_thanks_button
  • (1)post_thanks_javascript
  • (1)post_thanks_navbar_search
  • (1)post_thanks_postbit
  • (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
  • fetch_musername
  • post_thanks_function_fetch_thanks_end
  • post_thanks_function_thanked_already_start
  • post_thanks_function_thanked_already_end
  • post_thanks_function_fetch_thanks_bit_start
  • post_thanks_function_show_thanks_date_start
  • post_thanks_function_show_thanks_date_end
  • post_thanks_function_fetch_thanks_bit_end
  • post_thanks_function_fetch_post_thanks_template_start
  • post_thanks_function_fetch_post_thanks_template_end
  • 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