Installation
This is documentation for Drupal 7, which is no longer supported. Learn more and find resources for Drupal 7 sites
Don't have Brand installed?
Drush
You can use Drush to install this module using the following command, but you may wish to consult the module installation guide for further information.
drush pm-download brand
You can proceed to install the module using Drush, or you can use the administrative interface to install this module.
Composer
Composer is the preferred installation method, however there are other ways of installing Drupal modules. You can read about how to use composer to manage site dependencies, or you can use the following command if you're familiar with composer
composer require drupal/brand
You can proceed to install the module using Drush, or you can use the administrative interface to install this module.
Other
There are various other ways of installing Drupal modules, you can read all about them on the module installation guide.
You can proceed to install the module using Drush, or you can use the administrative interface to install this module.
Don't have Brand configured?
If you're skipping configuration, you may notice that you aren't allowed to choose any themes when creating a 'Brand'. This is because the module will assume that no themes are available for use and you must add them to a list of allowed themes or simply turn the feature off. This will be on by default, and it's to protect administrators from coming across websites configured for misuse and it poses additional barriers to prevent sites using themes created by a third party.
Before configuring Brand, you'll need to answer two questions.
- Do I need to restrict what themes I have available to me?
- Do I need to identify if there are collisions in configuring themes?
Based upon the above questions, you'll need to consider the following:
Configuring what themes are allowed to be used

Visit /admin/config/user-interface/brands/settings/, and scroll to where you're able to allow themes to be used by Brand.
If you do not require access controls over what themes can be selected, you can disable the functionality by clicking the checkbox with the title indicating the feature would be disabled. You can then proceed to use the rest of the form, or submit the form to save the changes.
If you do require additional restrictions based upon theme usage, you can add each theme using the AJAX multiple field form. You can add as many fields as required, and assign the values as necessary. The values are the machine names of all available themes on the site, but the themes will only appear on the Brand creation form when each theme desired is enabled.
Add the themes you need to, or disable the feature as required, use the rest of the form or submit the form.
Alternatively you can use the following drush commands to do this from the command line.
drush brand restrictwill place the restriction flag on, so that themes only allowed by administrators can be used by Brand.drush brand unrestrictwill remove the restriction flag, so any themes can be used by Brand.drush brand allow bartikwill allow Bartik to be used by this themedrush brand disallow bratikwill remove Bartik from the allowed themes list - if it has been allowed previously.
Values entered here will be serialized into the database for access via variable get and set functions.
Configuring conflicts

Visit /admin/config/user-interface/brands/, and scroll to where you're able to configure the text and message availability of conflict messages.
If you wish to show a message when a conflict occurs, you can enable conflicts using the checkbox labelled as such.
To choose what text shows up, you can use the text field with the tokens [[brand]] and [[brands]], which [[brand]]represents the Brand being used on the page, where [[brands]]is a list of all brands the page is using. The default message will show that when multiple brands are conflicting on a given page, it will use weight and title to determine which item will be used, and based off those values it will be the first available Brand in the list.
Values entered here will be serialized into the database for access via variable get and set functions.
Help improve this page
You can:
- Log in, click Edit, and edit this page
- Log in, click Discuss, update the Page status value, and suggest an improvement
- Log in and create a Documentation issue with your suggestion