modX.getTree
Last updated Apr 15th, 2021 | Page history | Improve this page | Report an issue
Support the team building MODX with a monthly donation.
The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.
Backers
Budget
$301 per month—let's make that $500!
Learn moremodX::getTree¶
Get a site tree from a single or multiple modResource instances.
Syntax¶
API Doc: modX::getTree()
array getTree ([int|array $id = null], [int $depth = 10], [array $options = array()])
-
$id
(int|array) A single or multiple modResource ids to build the tree from. -
$depth
(integer) The maximum depth to build the tree (default 10). -
$options
(array) An array of filtering options, such as 'context' to specify the context to grab from.
Example¶
Get a tree for the Resource with ID 12. Only go 5 levels deep.
$treeArray = $modx->getTree(12,5);