Drupal 7 Theme Hook Suggestions

Posted by bput4all on October 30, 2012 · 2 Comments 

Theme hook suggestions:

What’s a theme hook suggestion? It’s an alternate template (.tpl.php) file that you have created to override the base or original template file..

Custom Theme Hook Suggestions

Custom suggestions beyond the ones listed below can be created. See the page Working with template suggestions.

Default Theme Hook Suggestions in Core

block–[region|[module|–delta]].tpl.php

base template: block.tpl.phpTheme hook suggestions are made based on these factors, listed from the most specific template to the least. Drupal will use the most specific template it finds:

1. block–module–delta.tpl.php
2. block–module.tpl.php
3. block–region.tpl.php

“module” being the name of the module and “delta”, the internal id assigned to the block by the module.

For example, “block–block–1.tpl.php” would be used for the first user-submitted block added from the block administration screen since it was created by the block module with the id of 1. “region” will take effect for specific regions. An example of a region-specific template would be “block–sidebar_first.tpl.php“.

If you had a block created by a custom module called “custom” and a delta of “my-block”, the theme hook suggestion would be called “block–custom–my-block.tpl.php.”

comment–node-[type].tpl.php

base template: comment.tpl.phpSupport was added to create comment–node-type.tpl.php files, to format comments of a certain node type differently than other comments in the site. For example, a comment made on an article-type node would be “comment–node-article.tpl.php”.

comment-wrapper–node-[type].tpl.php

base template: comment-wrapper.tpl.phpSimilar to the above but for the wrapper template.

field–[type|name[–content-type]|content-type].tpl.php

base template: field.tpl.phpTheme hook suggestions are made based on these factors, listed from the most specific template to the least. Drupal will use the most specific template it finds:

1. field–field-name—content-type.tpl.php
2. field–content-type.tpl.php
3. field–field-name.tpl.php
4. field–field-type.tpl.php

Note that underscores in a Field’s machine name are replaced by hyphens. Also remember to include “field-” in custom field names, e.g: field–field-phone.tpl.php.

forums–[[container|topic]–forumID].tpl.php

base template: forums.tpl.phpTheme hook suggestions are made based on these factors, listed from the most specific template to the least. Drupal will use the most specific template it finds:For forum containers:

1. forums–containers–forumID.tpl.php
2. forums–forumID.tpl.php
3. forums–containers.tpl.php

For forum topics:

1. forums–topics–forumID.tpl.php
2. forums–forumID.tpl.php
3. forums–topics.tpl.php

html.tpl.php

base template: html.tpl.phpSee html.tpl.php in the Drupal API documentation for more information.

maintenance-page–[offline].tpl.php

base template: maintenance-page.tpl.phpThis applies when the database fails. Useful for presenting a friendlier page without error messages. Theming the maintenance page must be properly setup first.

node–[type|nodeid].tpl.php

base template: node.tpl.phpTheme hook suggestions are made based on these factors, listed from the most specific template to the least. Drupal will use the most specific template it finds:

1. node–nodeid.tpl.php
2. node–type.tpl.php
3. node.tpl.php

See node.tpl.php in the Drupal API documentation for more information.

page–[front|internal/path].tpl.php

base template: page.tpl.phpThe suggestions are numerous. The one that takes precedence is for the front page. The rest are based on the internal path of the current page. Do not confuse the internal path to path aliases which are not accounted for. Keep in mind that the commonly used Path auto module works its magic through path aliases.The front page can be set at “Administration > Configuration > System > Site information.” In Drupal 6, at “Administrator > Site configuration > Site information.”Anything set there will trigger the suggestion of “page–front.tpl.php” for it.

The list of suggested template files is in order of specificity based on internal paths. One suggestion is made for every element of the current path, though numeric elements are not carried to subsequent suggestions. For example, “http://www.example.com/node/1/edit” would result in the following suggestions:

1. page–node–edit.tpl.php
2. page–node–1.tpl.php
3. page–node.tpl.php
4. page.tpl.php

Also see page.tpl.php in the Drupal API documentation for more information.

How Drupal determines page theme hook suggestions based on path

Here is another explanation based on the theme_get_suggestions() function:

The list of possible templates for a given page is generated by Drupal through thetheme_get_suggestions() function, which is called by thetemplate_preprocess_page() function.

The Drupal path of the page is first broken up into its components. As mentioned above, the Drupal path is not any of its aliases: there is one and only one Drupal path for a page. For the examples “http://www.example.com/node/1/edit” and “http://www.example.com/mysitename?q=node/1/edit”, the Drupal path is node/1/edit, and its components are “node”, 1, and “edit”.

Next, the prefix is set to “page”. Then, for every component, the following logic is followed:

1. If the component is a number, add the prefix plus “__%” to the list of suggestions.
2. Regardless of whether the component is a number or not, add the prefix plus “__” plus the component to the list of suggestions.
3. If the component is not a number, append “__” plus the component to the prefix.

After the list of components is iterated through, if the page is the front page (as set through “Administration > Configuration > System > Site information.”), then “page__front” is added to the list of suggestions.

Note that eventually, to turn a suggestion into an actual file name, “__” gets turned into “–“, and “.tpl.php” gets appended to the suggestion. Thus, for node/1/edit, we get the following list of suggestions:

1. page.tpl.php (this is always a suggestion)
2. page–node.tpl.php (and prefix is set to page__node)
3. page–node–%.tpl.php
4. page–node–1.tpl.php (prefix is not changed because the component is a number)
5. page–node–edit.tpl.php (and prefix is set to page__node__edit)
6. page–front.tpl.php (but only if node/1/edit is the front page)

When the page is actually rendered, the last suggestion is checked. If it exists, that suggestion is used. Otherwise the next suggestion up is checked, and so on. Of course, if none of the overriding suggestions exist, page.tpl.php is the final suggestion. This also explains why page–front.tpl.php, if it exists, overrides any other suggestion for the front page: it is always the last suggestion for the page designated as the front page.

poll-results–[block].tpl.php

base template: poll-results.tpl.phpThe theme function that generates poll results are shared for nodes and blocks. The default is to use it for nodes but a suggestion is made for rendering them inside block regions. This suggestion is used by default and the template file is located at “modules/poll/poll-results–block.tpl.php”.

poll-vote–[block].tpl.php

base template: poll-vote.tpl.phpSimilar to poll-results–[block].tpl.php but for generating the voting form. You must provide your own template for it to take effect.

poll-bar–[block].tpl.php

base template: poll-bar.tpl.phpSame as poll-vote–[block].tpl.php but for generating individual bars.

profile-wrapper–[field].tpl.php

base template: profile-wrapper.tpl.phpThe profile wrapper template is used when browsing the member listings page. When browsing specific fields, a suggestion is made with the field name. For example,http://drupal.org/profile/country/Belgium would suggest “profile-wrapper–country.tpl.php”.

region–[region].tpl.php

base template: region.tpl.phpThe region template is used when a page region has content, either from the Block system or a function like hook_page_build(). Possible region names are determined by the theme’s .info file.

search-results–[searchType].tpl.php

base template: search-results.tpl.phpsearch-results.tpl.php is the default wrapper for search results. Depending on type of search different suggestions are made. For example, “example.com/search/node/Search+Term” would result in “search-results–node.tpl.php” being used. Compare that with “example.com/search/user/bob” resulting in “search-results–user.tpl.php”. Modules can extend search types adding more suggestions of their type.

search-result–[searchType].tpl.php

base template: search-result.tpl.phpThe same as above but for individual search results.

taxonomy-term–[vocabulary-machine-name|tid].tpl.php

base template: taxonomy-term.tpl.phpTheme hook suggestions are made based on these factors, listed from the most specific template to the least. Drupal will use the most specific template it finds:

1. taxonomy-term–tid.tpl.php
2. taxonomy-term–vocabulary-machine-name.tpl.php
3. taxonomy-term.tpl.php

Note that underscores in a vocabulary’s machine name are replaced by hyphens.

Cache issue

When working with theme hook suggestion, there is a possibility that Drupal use its cache rather than the new templates as suggested. Remove the cache if you experience this problem. To clear the cache, choose one of the methods described in Clearing Drupal’s cache.

source :Drupal org KB

Filed under drupal, php · Tagged with content type theming, custom theming in drupal 7, drupal 7 node type theming, node page, taxonomy page, taxonomy term theming, theme hook