Master your Drupal Sub Theme

By adam
Fri, 2015-05-29 21:08
3 comments

Share with Others

Awhile back I posted a video on setting up a Drupal sub-theme. If you want, you can check out that video here. I think that the video does an alright job of explaining the steps you have to take to get a sub-theme to work properly. I don't however think it provides enough of the setting up a sub-theme "meat" needed to begin. The saying goes, the devil is in the details. Personally, I never liked that quote, but it is fitting here. Anyway, if you're looking to get a full in-depth guide to setting up a Drupal sub-theme, you, my friend, just need to keep scrolling.

Let's begin.

What is a sub-theme anyway?

This seems like the appropriate place to start. Drupal has two types of themes; you have a base theme and a sub-theme. A base theme (Zen for example) provides basic theme design and functionality. The work has already been done for you. Cha-ching! A sub-theme provides all the unique design and functionality. A sub-theme where you get to build the exact website of your dreams.

If you're still confused, try thinking of it this way. Let's assume a base theme is the basic vanilla ice cream cone. A plain vanilla cone is still a cone. You could eat it up and leave happy, but what if you wanted to add some strawberry syrup? Adding the strawberry syrup is like adding the custom design to your site. So instead of having to create the entire cone (remember the vanilla was already provided) you just have to add the strawberry syrup or whatever you want to build the ice cream cone you desire. Drupal base themes and sub-themes work exactly like this. Using a base theme will provide you a lot of the design and functionality you need and then you can use a sub-theme to design the site exactly how you see fit.

Are all base themes created equal?

This is kind of a hot topic with designers in the Drupal community. In my opinion, the answer is nope. Every designer has their personal preferences to which base theme to use. Some of the most popular base themes are Zen, Omega, Fusion, and Basic. Personally, I use Zen. Any theme can be made into a sub-theme. This makes choosing a base theme endless. If you're just getting started with designing in Drupal, it is best to spend some time working with a variety of theme to find which theme works best for your coding style. Here a few reasons why Zen works for me.

  • Widely supported and used (over 1.5 million downloads)
  • Responsive out of the box
  • Supports SASS
  • Follows a concise file structure
  • Easily customizable

Downloading and enabling Zen

Let's start with getting Drupal Zen installed. You will want to go here and download the newest recommended release of Zen. To download, simply click on the either the .zip folder or .tar.gz folder. Once the download is complete go ahead and extract (unzip) the folder.

Note: I'm assuming you're using Drupal 7. If you're using a different version of Drupal things aren't going to work exactly the same.

Next, we need to move the folder onto our site. If you don't currently have a site setup, you can follow along with this video on setting up a site using Blue Host. If you have a site created already use your FTP client and move the folder into the sites/all/themes folder.

You want to place your base theme here as this is the folder that Drupal will look for your sites themes. If you want, you can download other base themes and move them inside the sites/all/themes folder. That's it, well at least for the Drupal base theme.

I'll add a little sub-theme to my base theme, please

This is where things start to get exciting. By exciting, I mean that in the nerdiest of ways. With the base theme installed, go ahead and navigate to the folder labeled Zen. Within the Zen folder, you will see a folder labeled STARTERKIT. This folder is our sub-theme. One thing of note, Zen provides you a sub-theme some of base themes will not. This is just another reason Zen is a great option!

Which the STARTERKIT folder selected go ahead and cut and paste the folder within the themes folder. Yep, this is the same place you put the Zen base theme. So when you are done, you should have two folders under the themes folder, one for Zen, and one for STARTERKIT. It is super important that these both are on the same level. If they aren't on the same level, then Zen won't know how to reference the sub-theme you will create.

Getting into the sub-theme details

Things are progressing nicely. We now have our base theme and sub-themes installed and in the right locations. Now we are going to look at configuring the sub-theme.

The first thing I like to do is rename the STARTERKIT folder to something a little more meaningful. You can name the folder however you want, but a few things to keep in mind is to avoid spaces and use a name that represents the site your building. For example, I like to use the company name the site is for.

There are few files that will need some attention. The first file you want to look at is the STARTERKIT.info.txt file. An info file is a static file for defining and configuring a theme. Before we edit the contents of the file go ahead and rename the file. For consistency sake, I always name the info file the same name as my sub-theme. So if I named my sub-theme codekarate, my info file would be named codekarate.info. You can go ahead and get rid of the .txt extension also.

There is more in the .info file then I am going to cover in this post. If you would like more information about the .info file, just make sure to let me know in the comments below.

Within the .info file go ahead and change the name and the description to something that fits your sub-theme. For the description, it's could practice to include information as to what base theme this sub-theme is using. So for example you description might look like this: "A custom theme for [store], based off of Zen.". Take this for what it's worth, it's 100% preference. For now, that is all you need to change within the .info file.

Still within the sub-theme, open up the theme-settings.php and template.php files. Within both of these files, you want to change EVERY instance of STARTERKIT to your theme name. For my example, I would replace STARTERKIT with codekarate. It's important that this matches EXACTLY to your theme name. A little hack is if you use the find and replace feature you can pretty quickly replace all of those instances.

Customizing the look with templates

We've spent a lot of words to get to this point. Thankfully, you're so close to the finish line. Before you click off and start building, I want to show you one more thing.

Zen works off of templates. These templates use HTML and PHP to control how the content is displayed on the site. There are templates for a variety of different sections of your site. Each of these templates controls the HTML structure and what pieces of content get displayed. They are super powerful. Here's the but. Since you are building your own custom sub-theme you don't want to just rely on the templates provided by the Zen base theme. You want the control, now let's take that control.

Within the Zen folder, locate a folder called templates. Inside of this folder are all the templates that control the layout of your site. Go ahead and copy the html.tpl.php and page.tpl.php files and paste them within your sub-themes template folder.

To modify ANY template you HAVE TO HAVE the html.tpl.php file within your sub-themes template folder. If you don't, no changes will take effect. Also, by default if you don't copy a template from the base theme to your sub-theme Drupal will remain using the template in the base theme.

Don't mess with Zen

So you might be thinking why would I mess around with creating all this sub-theme stuff when Zen provides me everything I already need. The answer resides in Drupal being an open source technology. Since Zen was built and continues to be enhanced by a group of individuals, there will ultimately be improvements/updates that you will want. If you start to "hack" the Zen base theme, then you import those new updates all of your changes will be erased. Not good. Just save yourself the headache and late nights and avoid modifying any base theme.

Wrap it up already

Hopefully, now you have strong understanding of what it takes to set up a sub-theme. There are a few steps that need to be taken, but like anything if you do it a few times it becomes second nature. As Micheal Jordan famously said, "You miss 100% of the shots you don't take." Take the shot and create something beautiful.

Do you use a different base theme? Which one, why, what's different? Let me know in the comments below.

Happy Coding.

Comments

Hi.

Thanks for your extremely helpful articles! :)

I followed all the instructions you set up in this article, but in the end I could not have my new sub theme available in the Appearance page of my Drupal web site.

After testing and retesting, I found out what was wrong: the name of sub theme's folder and .info files can't have "-" characters. I removed them from those names, although keeping them within the .info file, and magically my sub theme now appears in the available themes in the Appearance page!

So I think this is something that's worth being noted: the names of the sub theme's folder and .info files cannot have "-".

I hope this can help someone out there.

Best regards.
Reis

Reis -

Nice note. I do believe that you can use an underscore "_". So you could have a theme name like "my_theme". Honestly, for simplicity, I general steer clear of dashes and underscores when I can.

High school, school, and graduate students are swinging to expert writing services to complete their essay writing exercises. Admission essay writing service is ending up being more predominant with students. It may flabbergast you to find that very nearly half of all students in the US case to have used online essay writers help at any rate once in the midst of their insightful work. Organization essay writers commonly have various years of association in your field of study. Most associations have writers that create on particular subjects and branches of learning.
An essay writer ordinarily has various years of experience writing essays so you can be overall ensured that any essay you purchase will get a not too bad assessment in an academic setting. If you slant toward doing your own work these associations generally give adjusting and fixing services that you can use to upgrade or ensure the general way of your essay. It is straightforward for students to wind up overwhelmed and to fight especially in the later years of school when there are battling requirements for your time and thought. Conceivably your assessments have been slipping and you are on academic probation or possibly you have to work and manage the kids while you are in like manner still in school. Essay writing associations can be a honest to goodness get you through to the accompanying term, semester or academic year.
Fundamental points of interest of using admission essay writing service is recorded as extra your time, you get specialists' proposal, sensibility and they serve as arrangements for future assignments. Working with a site that does not ensure strikingly made essays is a wagered; you could end up expelled from school or stuck in a sad circumstance in case you turn in an essay that your teacher can find when checking for scholarly robbery. In case you don't utilize the best writing site, you won't get the best things.

Post new comment