function MenuTreeParameters::setMaxDepth

Same name in other branches
  1. 9 core/lib/Drupal/Core/Menu/MenuTreeParameters.php \Drupal\Core\Menu\MenuTreeParameters::setMaxDepth()
  2. 10 core/lib/Drupal/Core/Menu/MenuTreeParameters.php \Drupal\Core\Menu\MenuTreeParameters::setMaxDepth()
  3. 11.x core/lib/Drupal/Core/Menu/MenuTreeParameters.php \Drupal\Core\Menu\MenuTreeParameters::setMaxDepth()

Sets a maximum depth for menu tree loading.

@codeCoverageIgnore

Parameters

int $max_depth: The (root-relative) maximum depth to apply.

Return value

$this

1 call to MenuTreeParameters::setMaxDepth()
MenuTreeParameters::setTopLevelOnly in core/lib/Drupal/Core/Menu/MenuTreeParameters.php
Ensures only the top level of the tree is loaded.

File

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

Class

MenuTreeParameters
Provides a value object to model menu tree parameters.

Namespace

Drupal\Core\Menu

Code

public function setMaxDepth($max_depth) {
    $this->maxDepth = $max_depth;
    return $this;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.