Warning message

Newsletter category Drupal Developer newsletter format has not been set to HTML. There will be no statistics recorded for this newsletter.

Programmatically create vocabulary

In some situation, you module is required to create a taxonomy which the module use to perform other tasks/features it offers. This is when you can write a code to craete the require vocabulary in the module and make it availabel as soon as the module is installed. You can also add terms programatically to that vocabulary!

Using taxonomy_save_vocabulary for Drupal 5.x & 6.x and taxonomy_vocabulary_save for 7.x, you can create the vocabulary programmatically in your module.

Here is a Drupal 6.x example:

$vocabulary = array(
'name' => t("Currency"), //Human readable name of the vocabulary
'multiple' => 0, //set 1 to allow multiple selection
'required' => 0, //set 1 to make the terms mandatory to be selected
'hierarchy' => 0, //set 1 to allow and create hierarchy of the terms within the vocabulary
'relations' => 0, //set 1 to set and allow relation amongst multiple terms
'module' => 'mymodule', //provide the module name in which the vocabulary is defined and which is calling this function
'nodes' => array('mymodule' => 1), //set the node to which this vocabulary will be attached to
'weight' => -9, //set the weight to display the vocabulary in the list

taxonomy_save_vocabulary($vocabulary); //saving the $vocabulary array will create a vocabulary named "Currency". Note the t() in the 'name', this will allow to translate the vocabulary name to different languages.

The advantage of creating the vocabulary programmatically is to eliminate to configure the vocabulary manually after installing the module. This is like carrying everything with you what ever you need.

QR code for this page URL This page URL