XF 2.0 XenForo 2 Helper Function

[My Dime Is Up]

Hi everyone,

I'm looking to be able to use the XenForo 2 equivalent of "{xen:helper (function), $var}". I can't seem to find any documentation on this topic. Can anyone guide me in the right direction to creating my own helper (I already have my old code, just need to port it)

Thanks!

 

[au lait]

Listener.php

public static function templater_setup(\XF\Container $container, \XF\Template\Templater &$templater)
{
        $templater->addFunction('YOUR_FUNCTION', function(\XF\Template\Templater $templater, &$escape)
        {
           // CODE
        });
}

admin.php?code-events/listeners/

Add code event listener -> templater_setup

Template Code: {{ YOUR_FUNCTION($vars) }}


Something like that

 

[My Dime Is Up]

Listener.php

public static function templater_setup(\XF\Container $container, \XF\Template\Templater &$templater)
{
        $templater->addFunction('YOUR_FUNCTION', function(\XF\Template\Templater $templater, &$escape)
        {
           // CODE
        });
}

admin.php?code-events/listeners/

Add code event listener -> templater_setup

Template Code: {{ YOUR_FUNCTION($vars) }}


Something like that

Thanks, I tried this but had some problems. Here is what I input

Spoiler: Photos

[/SP

OILER]

I get this error:

• Template public:tkgmod_servers: Function steamid64fromuserid is unknown (src/XF/Template/Templater.php:861)

 

[au lait]

Please do not use capital letters


Not: steamId64FromUserId -> steamid64fromuserid
or
steamid64_from_userid

 

[My Dime Is Up]

Please do not use capital letters


Not: steamId64FromUserId -> steamid64fromuserid
or
steamid64_from_userid

Now it works. Thanks very much

 

[au lait]

Yep

public static function templater_setup(\XF\Container $container, \XF\Template\Templater &$templater)
{
        $templater->addFunction('YOUR_FUNCTION', function(\XF\Template\Templater $templater, &$escape, $var1, $var2 etc.)
        {
           // CODE
        });
}

{{ YOUR_FUNCTION($vars1, $var2 etc.) }}

 

[Arty]

Better use callback. There are some cases when event listeners are disabled, which would cause XenForo to throw errors because your custom function is not available. See https://xenforo.com/community/threa...cations-with-custom-tags.157575/#post-1304599

 

[Mike]

@Arty: you linked to me talking about not using custom template tags because there are situations where listeners aren't enabled when rebuilding templates. That doesn't apply to templater functions though, as they're purely run-time evaluated.

Do you have an example you're referring to? The RM and MG both use custom templater functions without issues. (Certainly there could be situations if you edit a template to include a function call and then disable the add-on, though arguably a callback may fail in that scenario, depending on the code in question.)

 

[Arty]

That doesn't apply to templater functions though, as they're purely run-time evaluated.

Oh right. Sorry.

 

[HappyWorld]

Thanks, i have same question as OP too