XF 2.3 Conditional

[Ozzy47]

Does anyone know if there is a conditional (to use in templates) to check if an addon is installed?

 

[Yenxji]

I think it's possible, that you can use is_addon_active() function on your templates.

<xf:if is_addon_active('Elf/AddonTitle')>
    <!-- Content to show when AddonTitle is installed -->
    AddonTitle is installed!
<xf:else />
    <!-- Content to show when AddonTitle is not installed -->
    AddonTitle is not installed.
</xf:if>

You can also use the exact addon ID to appears in the addon.json file. Format is typically VendorPrefix/AddonName.

Alternativve you can check for specific addon options if you want to verify not just installation but specific functionality,

<xf:if exists($xf.options.elf_addontitle_someoption)>
    <!-- Content that depends on a specific AddonTitle option -->
</xf:if>

 

[Ozzy47]

I'll have to check that out, I'll let ya know if it works.

 

[Ozzy47]

Neither of those worked, so I ended up checking in PHP then passing that along to my template.

 

[DimmmCom]

<xf:if is_addon_active('Elf/AddonTitle')>

<xf:if is="is_addon_active('Elf/AddonTitle')">

 

[Ozzy47]

<xf:if is="is_addon_active('Elf/AddonTitle')">

That did not give a syntax error like the previous examples so that's cool. But I went with doing it in PHP then calling it in my template.

        $options = \XF::options();
        
        // Check If Conversation View Addon Is Installed (so we can link to the convo and message in our log)
        $ozzmodzPmDmSearch = isset($options->ozzmodz_pmdmsearch_limit) && $options->ozzmodz_pmdmsearch_limit;

        $viewParams = [
            'ozzmodzPmDmSearch' => $ozzmodzPmDmSearch,
        ];

Then in my template:

                        <xf:if is="$ozzmodzPmDmSearch">
                            <xf:cell>{$this}</xf:cell>
                        <xf:else />
                            <xf:cell>{$that}</xf:cell>
                        </xf:if>

 

[DimmmCom]

That did not give a syntax error like the previous examples so that's cool. But I went with doing it in PHP then calling it in my template.

        $options = \XF::options();
       
        // Check If Conversation View Addon Is Installed (so we can link to the convo and message in our log)
        $ozzmodzPmDmSearch = isset($options->ozzmodz_pmdmsearch_limit) && $options->ozzmodz_pmdmsearch_limit;

        $viewParams = [
            'ozzmodzPmDmSearch' => $ozzmodzPmDmSearch,
        ];

Then in my template:

                        <xf:if is="$ozzmodzPmDmSearch">
                            <xf:cell>{$this}</xf:cell>
                        <xf:else />
                            <xf:cell>{$that}</xf:cell>
                        </xf:if>

If the check is only needed in the template, it seems logical to me to call the is_addon_active method from the template. But if you prefer to check in PHP, it is better to check if the addon is available using the \XF::isAddOnActive() method, because you are checking for the presence and content of options, and they will be available even if the addon is disabled, which will lead to unexpected results.

 

[Ozzy47]

Interesting, I'll have to change to that possibly.

 

[Ozzy47]

If the check is only needed in the template, it seems logical to me to call the is_addon_active method from the template. But if you prefer to check in PHP, it is better to check if the addon is available using the \XF::isAddOnActive() method, because you are checking for the presence and content of options, and they will be available even if the addon is disabled, which will lead to unexpected results.

Yes, that seems to work as expected, thank you.