- Compatible XF 2.x versions
- 2.2
- 2.3
Adds a new template variable $xf.itemsThisPage containing how many posts/media items/resources/etc. are shown on a page.
This is useful in templates if you want to adjust the display of some element based on how many posts or threads or media items there are displayed.
For example, you might want to hide an element from the sidebar on short threads (or on the last page of a thread where only one or two posts are shown), to prevent the sidebar from being much longer than the content.
Usage example:
The following code might be used in a sidebar ad placement to hide the advert on short thread pages.
An even easier way
If we combine this addon with the Template Parent addon, which gives us a shorthand way of referencing all of the various thread and forum types in template names using a new $xf.reply.templateParent template variable - we can simplify the above example even further:
Hiding ads when there is no content
I use the following code on PropertyChat to hide adverts when there is no content on the page:
... we can do this even on PAGE_CONTAINER level adverts because if $xf.itemsThisPage is not defined it will simply return null ... so by using $xf.itemsThisPage === 0 we can say "if it is defined and is actually equal to zero, then do this" ... while still doing something else on pages where it hasn't been defined and thus returns null.
This is useful in templates if you want to adjust the display of some element based on how many posts or threads or media items there are displayed.
For example, you might want to hide an element from the sidebar on short threads (or on the last page of a thread where only one or two posts are shown), to prevent the sidebar from being much longer than the content.
Usage example:
The following code might be used in a sidebar ad placement to hide the advert on short thread pages.
HTML:
<xf:if is="in_array($xf.reply.template, [
'thread_view',
'thread_view_type_article',
'thread_view_type_poll',
'thread_view_type_question',
'thread_view_type_suggestion'
]) && $xf.itemsThisPage <= 1">
<!-- show nothing -->
<xf:else />
<!-- show the item -->
</xf:if>An even easier way
If we combine this addon with the Template Parent addon, which gives us a shorthand way of referencing all of the various thread and forum types in template names using a new $xf.reply.templateParent template variable - we can simplify the above example even further:
HTML:
<xf:if is="$xf.reply.templateParent == 'thread_view' && $xf.itemsThisPage <= 1">
<!-- show nothing -->
<xf:else />
<!-- show the item -->
</xf:if>Hiding ads when there is no content
I use the following code on PropertyChat to hide adverts when there is no content on the page:
HTML:
<xf:if is="$xf.itemsThisPage === 0">
<!-- show nothing -->
<xf:else />
<!-- show the item -->
</xf:if>... we can do this even on PAGE_CONTAINER level adverts because if $xf.itemsThisPage is not defined it will simply return null ... so by using $xf.itemsThisPage === 0 we can say "if it is defined and is actually equal to zero, then do this" ... while still doing something else on pages where it hasn't been defined and thus returns null.
