Counting modules in a given module position: Difference between revisions

From Joomla! Documentation

mNo edit summary
Chris Davenport (talk | contribs)
m Added div's to code sample.
Line 1: Line 1:
<includeonly>== Counting Modules in a given Module position ==</includeonly>
<includeonly>== Counting Modules in a given Module position ==</includeonly>
The countModules function can be used within a template to determine the number of Modules enabled in a given Module position.  This is commonly used to include Modules in a certain position only if at least one Module is enabled for that position.  This prevents empty regions from being defined in the template output.
The countModules function can be used within a template to determine the number of modules enabled in a given module position.  This is commonly used to include HTML around modules in a certain position only if at least one module is enabled for that position.  This prevents empty regions from being defined in the template output and is a technique sometimes referred to as “collapsing columns”.


For example, the following code includes Modules in the 'user1' position only if at least one Module is enabled for that position.
For example, the following code includes modules in the 'user1' position only if at least one module is enabled for that position.  


<source lang="php">
<source lang="php">
<?php if ($this->countModules( 'user1' )) : ?>
<?php if ($this->countModules( 'user1' )) : ?>
   <jdoc:include type="modules" name="user1" style="rounded" />
   <div class="user1">
    <jdoc:include type="modules" name="user1" style="rounded" />
  </div>
<?php endif; ?>
<?php endif; ?>
</source>
</source>
 
<noinclude>[[Category:Intermediate]][[Category:Templates]][[Category:Topics]]</noinclude>
<noinclude>
[[Category:Intermediate]]
[[Category:Templates]]
[[Category:Topics]]
</noinclude>

Revision as of 08:13, 7 September 2008

The countModules function can be used within a template to determine the number of modules enabled in a given module position. This is commonly used to include HTML around modules in a certain position only if at least one module is enabled for that position. This prevents empty regions from being defined in the template output and is a technique sometimes referred to as “collapsing columns”.

For example, the following code includes modules in the 'user1' position only if at least one module is enabled for that position.

<?php if ($this->countModules( 'user1' )) : ?>
  <div class="user1">
    <jdoc:include type="modules" name="user1" style="rounded" />
  </div>
<?php endif; ?>