How to build your own sub-theme (6.x-1.x)

Last modified: November 11, 2009 - 09:22
NOTE: Before going through all the steps manually you might want to check out this - Automated ways to build a sub-theme (6.x)
IMPORTANT: In Drupal 6, the theme system caches template files and which theme functions should be called. What that means is if you add a new theme or preprocess function to your template.php file or add a new template (.tpl.php) file to your sub-theme, you will need to rebuild the "theme registry." See http://drupal.org/node/173880#theme-registry

Drupal 6 also stores a cache of the data in .info files. If you modify any lines in your sub-theme's .info file, you MUST refresh Drupal 6's cache by simply visiting the admin/build/themes page.

The base Zen theme is designed to be easily extended by its sub-themes. You shouldn't modify any of the CSS or PHP files in the zen/ folder; but instead you should create a sub-theme of zen which is located in a folder outside of the root zen/ folder. The examples below assume zen and your sub-theme will be installed in sites/all/themes/, but any valid theme directory is acceptable (see “Getting started” for more info.)

Why? To learn why you shouldn't modify any of the files in the zen/ folder, see Why use Zen?.

  1. Turn off CSS and Javascript file optimization before continuing. Visit admin/settings/performance and disable "Optimize CSS files" and "Optimize Javascript files".
  2. Copy the STARTERKIT folder out of the zen/ folder and rename it to be your new sub-theme. IMPORTANT: Only lowercase letters and underscores should be used for the name of your sub-theme.

    For example, copy the sites/all/themes/zen/STARTERKIT folder and rename it as sites/all/themes/foo.

    Why? Each theme should reside in its own folder. Unlike in Drupal 5, sub-themes can (and should) reside in a folder separate from their base theme.
  3. In your new sub-theme folder, rename the STARTERKIT.info.txt file to include the name of your new sub-theme. Then edit the .info file by changing any occurrence of STARTERKIT with the name of your sub-theme and editing the name and description field.

    For example, rename the foo/STARTERKIT.info.txt file to foo/foo.info. Edit the foo.info file and change "STARTERKIT.css" to "foo.css", change "name = Zen Sub-theme Starter Kit" to "name = Foo", and change "description = Read..." to "description = A Zen sub-theme".

    Why? The .info file describes the basic things about your theme: its name, description, features, template regions, CSS files, and JavaScript files. See the Drupal 6 Theme Guide for more info.

    Then, visit your site's admin/build/themes to refresh Drupal 6's cache of .info file data.

  4. If you want a liquid layout for your theme, copy the layout-liquid.css from the zen/zen folder and place it in your sub-theme's folder. If you want a fixed-width layout for your theme, copy the layout-fixed.css from the zen/zen folder and place it in your sub-theme's folder. Rename the layout stylesheet to "layout.css".

    For example, copy zen/zen/layout-fixed.css and rename it as foo/layout.css. Note that the .info file already has an entry for your layout.css file.

    Why? In Drupal 6 theming, if you want to modify a stylesheet included by the base theme or by a module, you should copy the stylesheet from the base theme or module's directory to your sub-theme's directory and then add the stylesheet to your .info file. See the Drupal 6 Theme Guide for more info.
  5. Copy the zen stylesheet from the zen folder and place it in your sub-theme's folder. Rename it to be the name of your sub-theme.

    For example, copy zen/zen/zen.css and rename it as foo/foo.css. Note that the .info file already has an entry for your foo.css file and that your .info file removes the base theme's zen.css file.

  6. Copy the print stylesheet from the zen folder and place it in your sub-theme's folder.

    For example, copy zen/zen/print.css to foo/print.css. Note that the .info file already has an entry for your print.css file.

  7. Copy the html-elements stylesheet from the zen folder and place it in your sub-theme's folder.

    For example, copy zen/zen/html-elements.css to foo/html-elements.css. Note that the .info file already has an entry for your html-elements.css file.

  8. Edit the template.php and theme-settings.php files in your sub-theme's folder; replace ALL occurrences of "STARTERKIT" with the name of your sub-theme.

    For example, edit foo/template.php and foo/theme-settings.php and replace "STARTERKIT" with "foo".

  9. Log in as an administrator on your Drupal site and go to Administer > Site building > Themes (admin/build/themes) and enable your new sub-theme.

    Optional:

  10. Modifying Zen core stylesheets: If you decide you want to modify any of the other stylesheets in the zen folder, copy them to your sub-theme's folder before making any changes. Also, be sure the new stylesheet is included in your .info file and that you have rebuilt the theme registry.

    For example, copy zen/zen/block-editing.css to foo/block-editing.css. Then edit foo/foo.info and uncomment this line to activate it:
    ;stylesheets[all][]  = block-editing.css
    to:
    stylesheets[all][]   = block-editing.css
    Then, visit your site's admin/build/themes to refresh Drupal 6's cache of .info file data.

  11. Modifying Zen core template files: If you decide you want to modify any of the .tpl.php template files in the zen folder, copy them to your sub-theme's folder before making any changes. And then rebuild the theme registry.

    For example, copy zen/zen/page.tpl.php to foo/page.tpl.php.

  12. Themeing Drupal’s search form: Copy the search-theme-form.tpl.php template file from the modules/search/ folder and place it in your sub-theme's folder. And then rebuild the theme registry.
    Why? In Drupal 6 theming, if you want to modify a template included by a module, you should copy the template file from the module's directory to your sub-theme's directory and then rebuild the theme registry. See the Drupal 6 Theme Guide for more info.
  13. Further extensions of your sub-theme: Discover further ways to extend your sub-theme by reading Drupal 6's Theme Guide

Key point when editing files on Windows!

djmmuir - November 24, 2009 - 19:28

If you work in Windows and host on Unix/Linux, it is really important to use standard Unix-aware FTP and editor applications.

Ensure that your editor maintains the file format in Unix/Linux (for linebreaks) and UTF-8 for character encoding. If you aren't careful about this, you will start to see the following error:
* warning: Invalid argument supplied for foreach() in /home/user/public_html/includes/theme.inc on line 463.
* warning: Invalid argument supplied for foreach() in /home/user/public_html/includes/theme.inc on line 468.

A great combination is NotePad++ and WS FTP Pro.

If you choose this combination of programs, here are a few minor hints:

  • set WS FTP Pro to use NotePad++ as its "Active Editor" for the file types you want (I set it for all file types)
  • set NotePad++ preferences so it doesn't restore sessions (this allows you to have WS FTP talk directly to NotePad++... downloading, opening the editor, sensing that the file is updated and the editor closed, and uploading the modified file)
  • set NotePad++ Format to Unix and UTF-8 with BOM (I check this for every single file I edit since a change to these files can happen almost any time one of the files lands on a Windows system)

More Specifically

Dash - December 3, 2009 - 12:08

Lines 463 and 468 in theme.inc refer to the styles and scripts called by your .info file (or any other styles called).

I had this problem when I'd just added nifty Corners to my test theme, re-encoded the .js and .css files as above and it's all fixed!

Thanks!

only for "styles" OR also for "the rest"

hyperzmart - January 16, 2010 - 13:42

the error(s) starting with;
"* warning: Invalid argument supplied for foreach() in"
- is something i get from time to time when testing new contributed modules.

found it interesting that UTF-8 may be an issue between UNIX and Windows and think this could then occur just about anywhere in any system as long as the files are Windowsed incompatible to UNIX.

how likely is it that some errors like this occur because module contributors distributes files that carry this problem around along the spread-outs of their files?

could this possibly be an issue to be centrally addressed and managed through out the whole community of everything D?

/dreaming of D10:)

Slight mistake

Zelka - December 18, 2009 - 11:03

"Turn off CSS and Javascript file optimization before continuing. Visit admin/settings/performance and disable "Optimize CSS files" and "Optimize Javascript files"."

It is actually under Admin - Site Configuration - Performance, I don't mean to be extra picky, but it took me (a newbie) quite a while to figure it out, so I thought I might help the other newbies.

Thanks for your time.

Regards,

Zelka

_______________________________________________________________________________________________________________

Honesty is the best policy

http://www.ashura.com.au/

admin/settings/performance is

jenlampton - December 19, 2009 - 01:41

admin/settings/performance is the path (the end of your URL) of the page you land on when you navigate: Admin > Site configuration > Performance.

They are one and the same, you can navigate there, or cut / paste in the path.

Jen

 
 

Drupal is a registered trademark of Dries Buytaert.