Commit c5b1666e authored by webchick's avatar webchick

Issue #1196116 by James_Stallings, foobar3000: Fixed...

Issue #1196116 by James_Stallings, foobar3000: Fixed taxonomy_vocabulary_save() doc needs more detail.
parent b633b3fd
......@@ -380,7 +380,26 @@ function taxonomy_admin_vocabulary_title_callback($vocabulary) {
}
/**
* Save a vocabulary given a vocabulary object.
* Saves a vocabulary.
*
* @param $vocabulary
* A vocabulary object with the following properties:
* - vid: The ID of the vocabulary.
* - name: The human-readable name of the vocabulary.
* - machine_name: The machine name of the vocabulary.
* - description: (optional) The vocabulary's description.
* - hierarchy: The hierarchy level of the vocabulary.
* - module: (optional) The module altering the vocabulary.
* - weight: (optional) The weight of this vocabulary in relation to other
* vocabularies.
* - original: (optional) The original vocabulary object before any changes
* are applied.
* - old_machine_name: (optional) The original machine name of the
* vocabulary.
*
* @return
* Status constant indicating whether the vocabulary was inserted (SAVED_NEW)
* or updated(SAVED_UPDATED).
*/
function taxonomy_vocabulary_save($vocabulary) {
// Prevent leading and trailing spaces in vocabulary names.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment