Theme: Which are the files in a typical drupal theme and their purpose
Posted by drupallovers on February 27, 2012
A drupal theme is a collection of files that define the presentation layer. You can also create one or more “sub-themes” or variations on a drupal theme. Only the .info file is required, but most themes and sub-themes will use other files as well. The following diagram illustrates the files that are found in a typical drupal theme and sub-theme.
- .info (required)
The internal name of the theme is also derived from this file. For example, if it is named “drop.info”, then Drupal will see the name of the theme as “drop”. Drupal 5 and below used the name of the enclosing folder of the theme.
Info files for themes are new in Drupal 6. In version 5, .info files were used solely for drupal modules.
- template files (.tpl.php)
- These drupal templates are used for the (x)HTML markup and PHP variables. In some situations they may output other types of data —xml rss for example. Each .tpl.php file handles the output of a specific themable chunk of data, and in some situations it can handle multiple .tpl.php files through suggestions. They are optional, and if none exists in your drupal theme it will fall back to the default output. Refrain from having complex logic in these files. In most cases, it should be straight (x)HTML tags and PHP variables. A handful of these templates exist in directories where core and contributed modules exist. Copying them to your drupal theme folder will force Drupal to read your version.
Note: The theme registry caches information about the available theming data. You must reset it when adding or removing template files or theme functions from your theme.
- For all the conditional logic and data processing of the output, there is the template.php file. It is not required, but to keep the .tpl.php files tidy it can be used to hold preprocessors for generating variables before they are merged with the markup inside .tpl.php files. Custom functions, overriding theme functions or any other customization of the raw output should also be done here. This file must start with a PHP opening tag ”
- On the surface, sub-themes behave just like any other drupal theme. The only differences is that they inherit the resources from their parent themes. To create one, a “base theme” entry inside the .info file is needed. From there it will inherit the resources from its parent theme. There can be multiple levels of inheritance; i.e., a sub-theme can declare another sub-theme as its base. There are no hard set limits to this.
Drupal 5 and below required sub-themes to be in sub-directories of the parent theme. This is no longer the case.
- The logo and screen shot is not absolutely necessary for the theme to function, but it is recommended, especially if you are contributing your theme to the Drupal repository. Screenshots will show inside the theme administration page and the user account settings for selecting themes when the appropriate permissions are set. See the screenshot guidelines for more information.
- To supply administrative UI settings or “features” beyond logo, search, mission, etc., a “theme-settings.php” file can be used. This is an advanced feature. More information can be found in the Advanced settings handbook page.
- For color module support, a “color” directory with a “color.inc” file is needed along with various support files.
- If you want to base your work on a core theme, use sub-theming or make a copy and rename the theme. Directly modifying Bartik, Garland or Minnelli is strongly discouraged, since they are used for the install and upgrade process.
- All non-Core or modifications to Core themes should be installed under the “sites/all/themes” directory to keep them separate from core files. If you plan to run multiple sites from a single Drupal code base, you can make a theme available to a specific site rather than all sites; read about how to set this up in Multi-site installations.