function menu_link_children_relative_depth

7.x menu_link_children_relative_depth($item)

Finds the depth of an item's children relative to its depth.

For example, if the item has a depth of 2, and the maximum of any child in the menu link tree is 5, the relative depth is 3.


$item: An array representing a menu link item.

Return value

The relative depth, or zero.

Related topics

3 calls to menu_link_children_relative_depth()
menu_link_save in drupal/includes/
Saves a menu link.
_book_parent_depth_limit in drupal/modules/book/book.module
Finds the depth limit for items in the parent select.
_menu_parent_depth_limit in drupal/modules/menu/menu.module
Find the depth limit for items in the parent select.


drupal/includes/, line 3424
API for the Drupal menu system.


function menu_link_children_relative_depth($item) {
  $query = db_select('menu_links');
  $query->addField('menu_links', 'depth');
  $query->condition('menu_name', $item['menu_name']);
  $query->orderBy('depth', 'DESC');
  $query->range(0, 1);

  $i = 1;
  $p = 'p1';
  while ($i <= MENU_MAX_DEPTH && $item[$p]) {
    $query->condition($p, $item[$p]);
    $p = 'p' . ++$i;

  $max_depth = $query->execute()->fetchField();

  return ($max_depth > $item['depth']) ? $max_depth - $item['depth'] : 0;