Adding a class to "body"
Asked Answered
C

10

34

How can I modify or pre-process the <body> tag to add the class body? I don't want to create a whole html.tpl.php just to add a class.

Circassia answered 9/10, 2011 at 1:23 Comment(0)
L
55

In your theme's template.php file use the preprocess_html hook:

function mytheme_preprocess_html(&$vars) {
  $vars['classes_array'][] = 'new-class';
}

Remember to clear the caches once you've implemented the hook or Drupal won't pick it up.

Lyontine answered 9/10, 2011 at 1:35 Comment(6)
How does it know to add to body?Circassia
There's only one element in html.tpl.php that has any classes added which is the <body> element; the preprocess function above is for that file, so any classes you add will only be added to the <body> element.Lyontine
By the way, if you haven't already got it install the Devel module and use the dpm function on any variable throughout your code; it will render a nice representation of classes and arrays that are put in the usual message area...it's an absolute must for debugging. You could use it in the above function for example like this: dpm($vars); and it would print the array out to the screen so you can inspect itLyontine
I have tried this (cleared cache, checked spelling, etc) and it didn't work. Is there a case that it is affected by another module? I am using context and the omega theme, btw.Pyrology
@Pyrology Probably a bit late now, but for Omega you want to implement mytheme_alpha_preprocess_html and add the class to the $vars['attributes_array']['class'] arrayLyontine
@Lyontine thanks for the omega-specific tip, helped me figure out why this answer wasn't working for my site.Appraisal
B
9

The documentation for the html.tpl.php template documents the $classes variables as String of classes that can be used to style contextually through CSS.. If you look at the code for the template, this variable is used in the class attributes of the produced body element:

<body class="<?php print $classes; ?>" <?php print $attributes;?>>

The $classes variables is actually already set by template_process() for any template file and build from the content of the $classes_array variable.

So to add a class to the body of your page, you should add this class to the $classes_array value from your theme (or module)'s implementation of hook_preprocess_html():

function THEME_preprocess_html(&$variables) {
  $variables['classes_array'][] = 'new-class';
}

Since this is the core defined template and process function, any well-behaving theme should re-use the same variables.

Biggs answered 31/10, 2011 at 11:1 Comment(0)
G
5

I had to use different array keys in the same hook to make it work:

function THEME_preprocess_html(&$vars) {
  $vars['attributes_array']['class'][] = 'foo2';
}
Gingili answered 30/4, 2013 at 11:47 Comment(0)
J
2

The Context module allows you to add a class to the body tag as well.

This can be useful if you need the class to be added under certain conditions.

You find this options under the reaction "Theme HTML" :

Theme HTML option in Context UI

Jereme answered 23/9, 2014 at 14:0 Comment(0)
M
2

Common Body Class module provide users to add classes to any page through the an interface. The interface has options to select multiple user roles as well as pages where the class can be rendered.

Example

Medicinal answered 31/3, 2017 at 10:49 Comment(0)
G
1

The answer appears to depend on context. Here's what I've found via trial-and-error:

If your hook_preprocess_html() is in a module, use $vars['classes_array'][].

If it's in a theme, use $vars['attributes_array']['class'][].

Giordano answered 25/6, 2013 at 0:18 Comment(1)
Not quite - attributes_array is defined specifically by the Omega theme. For 'normal' themes it'll be classes_arrayLyontine
C
0

I applied this technique on a site that someone else built. It didn't work at first but then dug deeper and found that the $classes variable was not being output in the tpl file. So if it's not working, check that.

Colloquy answered 16/5, 2013 at 14:52 Comment(0)
K
0

For Drupal 7 install http://drupal.org/project/body_class. It will help you to add seperate classes for each node in body tag

Kenlee answered 27/11, 2019 at 17:43 Comment(0)
P
0

You can check "https://www.drupal.org/project/page_specific_class" to add class to body tag of any page

Phyfe answered 23/12, 2019 at 5:48 Comment(1)
sometimes it's better to write your answer ( from anywhere ) instead of external links.Pepito
M
0

It's a simple way to add a class based on the URL, Drupal 9. No need to enable the Modules.

/**
 * Implements hook_preprocess_html().
 */
function THEME_NAME_preprocess_html(&$variables) {
  // Get the current path
  $current_path = \Drupal::service('path.current')->getPath();
  $internal_path = \Drupal::service('path_alias.manager')->getAliasByPath($current_path);

  // Assign it to body class 
  $variables['attributes']['class'][] = str_replace("/", "", $internal_path);
}

Refer: http://www.thirstysix.com/how-can-i-add-body-class-based-path-page-specific-class-drupal-9

Mouldy answered 12/7, 2021 at 8:13 Comment(0)

© 2022 - 2024 — McMap. All rights reserved.