View source for Applying custom module chrome

=== Custom Chrome Attributes === <!--T:9-->
It is also possible to pass further attributes into the Module chrome function using the same ''<jdoc:include />'' statement that sets the Module chrome. These additional attributes can be anything you like, and are stored in the ''$attribs'' array. Take the following example Module chrome function:

<!--T:10-->
<syntaxhighlight lang="php">
<?php
  function modChrome_custom( $module, &$params, &$attribs ) {
    if (isset( $attribs['headerLevel'] ))
    {
      $headerLevel = $attribs['headerLevel'];
    } else {
      $headerLevel = 3;
    }

    <!--T:11-->
if (isset( $attribs['background'] ))
    {
      $background = $attribs['background'];
    } else {
      $background = 'blue';
    }

    <!--T:12-->
echo '<div class="' .$params->get( 'moduleclass_sfx' ) .'" >';

    <!--T:13-->
if ($module->showtitle)
    {
      echo '<h' .$headerLevel .'>' .$module->title .'</h' .$headerLevel .'>';
    }

    <!--T:14-->
echo '<div class="' .$background .'">';
    echo $module->content;
    echo '</div>';

    <!--T:15-->
echo '</div>';
  }
?>
</syntaxhighlight>

<!--T:16-->
You would then set the values for ''background'' and ''headerLevel'' in the ''<jdoc:include />'' statement as shown below. If no values are set, the attributes default to ''blue'' and ''3'' respectively.

<!--T:17-->
{| class="wikitable"
|+ Passing attributes to Module chrome from ''<jdoc:include />''
! ''<jdoc:include />'' statement
! Output
|-
|
''<jdoc:include type="modules" name="user1" style="custom" />''
|
<syntaxhighlight lang="html4strict">
<div>
  <h3><!-- Module title --></h3>

  <!--T:18-->
<div class="blue">
    <!-- Module content -->
  </div>
</div>
</syntaxhighlight>
|-
|
''<jdoc:include type="modules" name="user1" style="custom" background="green" />''
|
<syntaxhighlight lang="html4strict">
<div>
  <h3><!-- Module title --></h3>

  <!--T:19-->
<div class="green">
    <!-- Module content -->
  </div>
</div>
</syntaxhighlight>
|-
|
''<jdoc:include type="modules" name="user1" style="custom" headerLevel="1" background="yellow" />''
|
<syntaxhighlight lang="html4strict">
<div>
  <h1><!-- Module title --></h1>

  <!--T:20-->
<div class="yellow">
    <!-- Module content -->
  </div>
</div>
</syntaxhighlight>
|}
Further information about passing attributes to Module chrome can be found in [[jtopic:115953]].
</translate>
<noinclude>
[[Category:Advanced]]
[[Category:Modules]]
[[Category:Template Development]]
[[Category:Template Reference]]
</noinclude>