You are here

Home » API reference » Drupal 9 » MenuTreeParameters.php » MenuTreeParameters

public property MenuTreeParameters::$root in Drupal 9

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Menu/MenuTreeParameters.php \Drupal\Core\Menu\MenuTreeParameters::root

A menu link plugin ID that should be used as the root.

By default the root ID of empty string '' is used. However, when only the descendants (subtree) of a certain menu link are needed, a custom root can be specified.

Type: string

File

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

Class

MenuTreeParameters
Provides a value object to model menu tree parameters.

Namespace

Drupal\Core\Menu

Code

public $root = '';