Plugin conflict: template hooks break when I use $templater = vB_Template::create();

[DetroitYES]

I'm having a strange error where calling $templater = vB_Template::create(); in a plugin causes other plugins that utilize template hooks to break.

here is the plugin that calls $templater = vB_Template::create();

product: vBulletin
hook location: global_start
execution order: 5

PHP Code:


include($_SERVER['DOCUMENT_ROOT'].'/_components/globalvars.php');
// Register my_var with the custom template
$templater = vB_Template::create('test_Open');

$resorts = array("a", "b", "c", "d");
$resort = highest_directory(); //called from test_php_functions, which is included on left_sidebar template...

ob_start();

include($_SERVER['DOCUMENT_ROOT'].'/_components/blocks/template_blocks/header.php');

$header_html = ob_get_contents();
    ob_end_clean();

ob_start();

include ($_SERVER['DOCUMENT_ROOT'].$site_components.'/blocks/booking-widget.php');

$booking_widget = ob_get_contents();
    ob_end_clean();

$templater->register('booking_widget', $booking_widget);
$templater->register('header_html', $header_html);


// Render the custom template
$my_template_output = $templater->render();

// Add the output from the template to the header template
$global_temp = $GLOBALS['header'];
$GLOBALS['header'] = $my_template_output;
$GLOBALS['header'] .= $global_temp; 


here is the plugin breaks when the above plugin is active:

product: atdtwt
hook location: showthread_start (also tried global_start)
execution order: 5 (also tried 4 and 10)

I also tried using diffrent template hooks (head

PHP Code:


$atdtwt_js = "\n".'<script type="text/javascript" src="atdtwt_js.php?do=main"></script>'."\n".'<link rel="stylesheet" type="text/css" href="clientscript/atdtwt/main.css" />'."\n";

$template_hook[headinclude_bottom_css] .= $atdtwt_js; 


If i change the first plugin to the following, the above plugin will work:

PHP Code:


include($_SERVER['DOCUMENT_ROOT'].'/_components/globalvars.php');
// Register my_var with the custom template
//$templater = vB_Template::create('test_Open');

$resorts = array("a", "b", "c", "d");
$resort = highest_directory(); //called from test_php_functions, which is included on left_sidebar template...

ob_start();

include($_SERVER['DOCUMENT_ROOT'].'/_components/blocks/template_blocks/header.php');

$header_html = ob_get_contents();
    ob_end_clean();

ob_start();

include ($_SERVER['DOCUMENT_ROOT'].$site_components.'/blocks/booking-widget.php');

$booking_widget = ob_get_contents();
    ob_end_clean();

//$templater->register('booking_widget', $booking_widget);
//$templater->register('header_html', $header_html);


// Render the custom template
//$my_template_output = $templater->render();

// Add the output from the template to the header template
//$global_temp = $GLOBALS['header'];
//$GLOBALS['header'] = $my_template_output;
//$GLOBALS['header'] .= $global_temp; 


I was able to isolate $templater = vB_Template::create(); as the problem by clearing out the code in the plugin, and making a call to an empty template (as to ensure the template wasn't the problem)...

PHP Code:


$templater = vB_Template::create('DUMMY'); 


What's going on, any ideas? This happens in the VB4 default skin. I've just installed vb 4.2.0

[kh99]

Change the second (broken) plugin to use hook parse_templates. Your use of a template in global_start causes the 'standard' templates (including headinclude) to be rendered, so by the time execution reaches showthread_start it's too late to set a template hook.

Edit: you may also have to enclose the code in that second template in if (THIS_SCRIPT == 'showthread') { /* code here */ } otherwise it will be on every page.

[Lynne]

Just to add that global_start is also deprecated. People need to start paying attention to that because it could disappear at any time (it's been two years since it was deprecated).

[DetroitYES]

Originally Posted by Lynne

Just to add that global_start is also deprecated. People need to start paying attention to that because it could disappear at any time (it's been two years since it was deprecated).

I think this points more towards the root of the problem. If i change the borken plugin to fire on parse_templates, the product will then fail to work on boards that don't utilize vB_Template::create(); at global_start...

Edit: I changed the broken plugin to kh99's suggestion and the template plugins to fire at global_bootstrap_init_start and that seemed to have solved it. The plugin works correctly in my custom skin and the default now. Thanks.


product: atdtwt
hook location: parse_templates
execution order: 5

PHP Code:


if (THIS_SCRIPT == 'showthread') {
    $atdtwt_js = "\n".'<script type="text/javascript" src="atdtwt_js.php?do=main">    </script>'."\n".'<link rel="stylesheet" type="text/css" href="clientscript/atdtwt/main.css" />'."\n";

    $template_hook[headinclude_bottom_css] .= $atdtwt_js;
} 


[kh99]

Originally Posted by DetroitYES

If i change the borken plugin to fire on parse_templates, the product will then fail to work on boards that don't utilize vB_Template::create(); at global_start...

I don't think that's true. parse_templates is always called just before the header, headinclude, headinclude_bottom, and footer templates are rendered, so I believe that's the correct hook to use for a plugin that wants to add to one of those templates. In fact, if the goal of your new plugin is to add to one of those templates then you'd probably want to use that hook as well.

[DetroitYES]

One more minor thing, changing to global_bootstrap_init_start seems to have removed the titles 'Quick Style Chooser', 'Standard Styles', and 'Mobile Styles' from my quick style chooser? Am I causing another conflict?

[kh99]

I don't know why that is, but my guess is that global_bootstrap_init_start may be called too early for what your plugin is doing.

Edit: have you tried global_bootstrap_complete?

[DetroitYES]

That did it, all is well, thanks a lot everyone.