Add Custom Block Regions to Drupal Themes

How-to add custom regions for displaying block content to Drupal themes.

Create and/or add the following to template.php

<span style="color: #369;">&lt;?php</span><span style="color: #000;">&nbsp;

</span><span style="color: #555;">/**

*&nbsp;Creates&nbsp;new&nbsp;regions&nbsp;which&nbsp;can&nbsp;be&nbsp;used&nbsp;to&nbsp;display&nbsp;blocks&nbsp;content.

*/</span><span style="color: #000;">

</span><span style="color: #00C;">function</span><span style="color: #000;">&nbsp;</span><span style="color: #000;">your_theme_regions</span><span style="color: #000;">()&nbsp;{

&nbsp;&nbsp;</span><span style="color: #00C;">return</span><span style="color: #000;">&nbsp;</span><span style="color: #00C;">array</span><span style="color: #000;">(

&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #F39;">'right'</span><span style="color: #000;">&nbsp;=&gt;&nbsp;</span><span style="color: #000;">t</span><span style="color: #000;">(</span><span style="color: #F39;">'right&nbsp;sidebar'</span><span style="color: #000;">),

&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #F39;">'left'</span><span style="color: #000;">&nbsp;&nbsp;=&gt;&nbsp;&nbsp;</span><span style="color: #000;">t</span><span style="color: #000;">(</span><span style="color: #F39;">'left&nbsp;sidebar'</span><span style="color: #000;">),

&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #F39;">'content'</span><span style="color: #000;">&nbsp;=&gt;&nbsp;</span><span style="color: #000;">t</span><span style="color: #000;">(</span><span style="color: #F39;">'content'</span><span style="color: #000;">),

&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #F39;">'header'</span><span style="color: #000;">&nbsp;=&gt;&nbsp;</span><span style="color: #000;">t</span><span style="color: #000;">(</span><span style="color: #F39;">'header'</span><span style="color: #000;">),

&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #F39;">'footer'</span><span style="color: #000;">&nbsp;=&gt;&nbsp;</span><span style="color: #000;">t</span><span style="color: #000;">(</span><span style="color: #F39;">'footer'</span><span style="color: #000;">),

&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #F39;">'custom'</span><span style="color: #000;">&nbsp;=&gt;&nbsp;</span><span style="color: #000;">t</span><span style="color: #000;">(</span><span style="color: #F39;">'custom&nbsp;region'</span><span style="color: #000;">),&nbsp;</span><span style="color: #555;">//&nbsp;Custom&nbsp;region

</span><span style="color: #000;">&nbsp;&nbsp;);

}&nbsp;</span><span style="color: #555;">//&nbsp;End&nbsp;your_theme_regions()

</span><span style="color: #369;">?&gt;</span>

<br />
<div class="geshifilter">
<div class="geshifilter-php" style="font-family: monospace;"> <br />
<span style="color: #666666; font-style: italic;">/**<br />
* Creates new regions which can be used to display blocks content.<br />
*/</span><br />
<span style="color: #000000; font-weight: bold;">function</span> your_theme_regions<span style="color: #009900;">(</span><span style="color: #009900;">)</span> <span style="color: #009900;">{</span><br />
  <span style="color: #b1b100;">return</span> <a href="http://www.php.net/array"><span style="color: #990000;">array</span></a><span style="color: #009900;">(</span><br />
    <span style="color: #0000ff;">'right'</span> <span style="color: #339933;">=></span> t<span style="color: #009900;">(</span><span style="color: #0000ff;">'right sidebar'</span><span style="color: #009900;">)</span><span style="color: #339933;">,</span><br />
    <span style="color: #0000ff;">'left'</span>  <span style="color: #339933;">=></span>  t<span style="color: #009900;">(</span><span style="color: #0000ff;">'left sidebar'</span><span style="color: #009900;">)</span><span style="color: #339933;">,</span><br />
    <span style="color: #0000ff;">'content'</span> <span style="color: #339933;">=></span> t<span style="color: #009900;">(</span><span style="color: #0000ff;">'content'</span><span style="color: #009900;">)</span><span style="color: #339933;">,</span><br />
    <span style="color: #0000ff;">'header'</span> <span style="color: #339933;">=></span> t<span style="color: #009900;">(</span><span style="color: #0000ff;">'header'</span><span style="color: #009900;">)</span><span style="color: #339933;">,</span><br />
    <span style="color: #0000ff;">'footer'</span> <span style="color: #339933;">=></span> t<span style="color: #009900;">(</span><span style="color: #0000ff;">'footer'</span><span style="color: #009900;">)</span><span style="color: #339933;">,</span><br />
    <span style="color: #0000ff;">'custom'</span> <span style="color: #339933;">=></span> t<span style="color: #009900;">(</span><span style="color: #0000ff;">'custom region'</span><span style="color: #009900;">)</span><span style="color: #339933;">,</span> <span style="color: #666666; font-style: italic;">// Custom region</span><br />
  <span style="color: #009900;">)</span><span style="color: #339933;">;</span><br />
<span style="color: #009900;">}</span> <span style="color: #666666; font-style: italic;">// End your_theme_regions()</span></div>
</div>
<p>

To display the output of your new region, use

<span style="color: #369;">&lt;?php</span><span style="color: #000;">&nbsp;</span><span style="color: #00C;">print</span><span style="color: #000;">&nbsp;</span><span style="color: #000;">$custom</span><span style="color: #000;">;&nbsp;</span><span style="color: #369;">?&gt;</span>

<span style="color: #369;">&lt;?php</span><span style="color: #000;">&nbsp;</span><span style="color: #00C;">if</span><span style="color: #000;">&nbsp;(</span><span style="color: #000;">$custom</span><span style="color: #000;">)&nbsp;</span><span style="color: #00C;">print</span><span style="color: #000;">&nbsp;</span><span style="color: #000;">$custom</span><span style="color: #000;">;&nbsp;</span><span style="color: #369;">?&gt;</span>

Submitted by Erik on Mon, 09/10/2007 - 16:09.

Add Custom Block Regions to Drupal Themes

Recent Entries

Recently Viewed