public function MenuTreeParameters::excludeRoot in Drupal 9

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Menu/MenuTreeParameters.php \Drupal\Core\Menu\MenuTreeParameters::excludeRoot()
2. 10 core/lib/Drupal/Core/Menu/MenuTreeParameters.php \Drupal\Core\Menu\MenuTreeParameters::excludeRoot()

Excludes the root menu link from the tree.

Note that this is only necessary when you specified a custom root, because the normal root ID is the empty string, '', which does not correspond to an actual menu link. Hence when loading a menu link tree without specifying a custom root the tree will start at the children even if this method has not been called.

Return value

$this

File

core/lib/Drupal/Core/Menu/MenuTreeParameters.php, line 206

Class

MenuTreeParameters

Provides a value object to model menu tree parameters.

Namespace

Drupal\Core\Menu

Code

public function excludeRoot() {
  $this
    ->setMinDepth(1);
  return $this;
}