function taxonomy_get_tree

Create a hierarchical representation of a vocabulary.

Parameters

string $vocabulary_name: The vocabulary for which to generate the tree.

int $parent: The term ID under which to generate the tree. If 0, generate the tree for the entire vocabulary.

int $max_depth: The number of levels of the tree to return. Leave NULL to return all levels.

bool $load_entities: If TRUE, a full entity load will occur on the term objects. Otherwise they are partial objects queried directly from the {taxonomy_term_data} table to save execution time and memory consumption when listing large numbers of terms. Defaults to FALSE.

Return value

An array of all term objects in the tree. Each term object is extended: to have "depth" and "parents" attributes in addition to its normal ones. Results are statically cached. Term objects will be partial or complete depending on the $load_entities parameter.

File

core/modules/taxonomy/taxonomy.module, line 987

Enables the organization of content into categories.

Code

function taxonomy_get_tree($vocabulary_name, $parent = 0, $max_depth = NULL, $load_entities = FALSE) {
  $children = &backdrop_static(__FUNCTION__, array());
  $parents = &backdrop_static(__FUNCTION__ . ':parents', array());
  $terms = &backdrop_static(__FUNCTION__ . ':terms', array());

  // We cache trees, so it's not CPU-intensive to call taxonomy_get_tree() on a
  // term and its children, too.
  if (!isset($children[$vocabulary_name])) {
    $children[$vocabulary_name] = array();
    $parents[$vocabulary_name] = array();
    $terms[$vocabulary_name] = array();

    $query = db_select('taxonomy_term_data', 't');
    $query->join('taxonomy_term_hierarchy', 'h', 'h.tid = t.tid');
    $result = $query
    ->addTag('translatable')
      ->addTag('taxonomy_term_access')
      ->fields('t')
      ->fields('h', array('parent'))
      ->condition('t.vocabulary', $vocabulary_name)
      ->orderBy('t.weight')
      ->orderBy('t.name')
      ->execute();

    foreach ($result as $term) {
      $children[$vocabulary_name][$term->parent][] = $term->tid;
      $parents[$vocabulary_name][$term->tid][] = $term->parent;
      $terms[$vocabulary_name][$term->tid] = $term;
    }
  }

  // Load full entities, if necessary. The entity controller statically
  // caches the results.
  if ($load_entities) {
    $term_entities = taxonomy_term_load_multiple(array_keys($terms[$vocabulary_name]));
  }

  $max_depth = (!isset($max_depth)) ? count($children[$vocabulary_name]) : $max_depth;
  $tree = array();

  // Keeps track of the parents we have to process, the last entry is used
  // for the next processing step.
  $process_parents = array();
  $process_parents[] = $parent;

  // Loops over the parent terms and adds its children to the tree array.
  // Uses a loop instead of a recursion, because it's more efficient.
  while (count($process_parents)) {
    $parent = array_pop($process_parents);
    // The number of parents determines the current depth.
    $depth = count($process_parents);
    if ($max_depth > $depth && !empty($children[$vocabulary_name][$parent])) {
      $has_children = FALSE;
      $child = current($children[$vocabulary_name][$parent]);
      do {
        if (empty($child)) {
          break;
        }
        $term = $load_entities ? $term_entities[$child] : $terms[$vocabulary_name][$child];
        if (isset($parents[$vocabulary_name][$term->tid])) {
          // Clone the term so that the depth attribute remains correct
          // in the event of multiple parents.
          $term = clone $term;
        }
        $term->depth = $depth;
        unset($term->parent);
        $term->parents = $parents[$vocabulary_name][$term->tid];
        $tree[] = $term;
        if (!empty($children[$vocabulary_name][$term->tid])) {
          $has_children = TRUE;

          // We have to continue with this parent later.
          $process_parents[] = $parent;
          // Use the current term as parent for the next iteration.
          $process_parents[] = $term->tid;

          // Reset pointers for child lists because we step in there more often
          // with multi parents.
          reset($children[$vocabulary_name][$term->tid]);
          // Move pointer so that we get the correct term the next time.
          next($children[$vocabulary_name][$parent]);
          break;
        }
      } while ($child = next($children[$vocabulary_name][$parent]));

      if (!$has_children) {
        // We processed all terms in this hierarchy-level, reset pointer
        // so that this function works the next time it gets called.
        reset($children[$vocabulary_name][$parent]);
      }
    }
  }

  return $tree;
}