Difference between revisions of "Counting modules in a given module position"

From Joomla! Documentation
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
<includeonly>== Counting Modules in a given Module position ==</includeonly>
+
The countModules method 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”.
−
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.
 
  
−
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]]</noinclude>
+
[[Category:Tutorials]][[Category:Template Development]]
−
<noinclude>[[Category:Templates]]</noinclude>
 
−
<noinclude>[[Category:Topics]]</noinclude>
 

Revision as of 07:47, 20 September 2010

The countModules method 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; ?>
Retrieved from "https://docs.joomla.org/index.php?title=Counting_modules_in_a_given_module_position&oldid=30924"