function WorkspaceRepositoryInterface::loadTree

Same name in other branches
  1. 8.9.x core/modules/workspaces/src/WorkspaceRepositoryInterface.php \Drupal\workspaces\WorkspaceRepositoryInterface::loadTree()
  2. 10 core/modules/workspaces/src/WorkspaceRepositoryInterface.php \Drupal\workspaces\WorkspaceRepositoryInterface::loadTree()
  3. 11.x core/modules/workspaces/src/WorkspaceRepositoryInterface.php \Drupal\workspaces\WorkspaceRepositoryInterface::loadTree()

Returns an array of workspaces tree item properties, sorted in tree order.

Return value

array An array of workspace tree item properties, keyed by the workspace IDs. The tree item properties are:

  • depth: The depth of the workspace in the tree;
  • ancestors: The ancestor IDs of the workspace;
  • descendants: The descendant IDs of the workspace.
1 method overrides WorkspaceRepositoryInterface::loadTree()
WorkspaceRepository::loadTree in core/modules/workspaces/src/WorkspaceRepository.php
Returns an array of workspaces tree item properties, sorted in tree order.

File

core/modules/workspaces/src/WorkspaceRepositoryInterface.php, line 20

Class

WorkspaceRepositoryInterface
Provides an interface for workspace tree lookup operations.

Namespace

Drupal\workspaces

Code

public function loadTree();

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