getDocumentChildren

Last edited by JP DeVries on Aug 10, 2013.

API:getDocumentChildren

API Quick reference
Variable name: getDocumentChildren
Modx versions: 0.9.x + Evolution
Input parameters:  
Return if successful:  
Return type: array
Return on failure:  
Object parent: DocumentParser

Description / Usage

array getDocumentChildren($id=-1, $active=1, $deleted='0', $fields='id, pagetitle, description, alias, parent', $where, $sort, $direction, $limit);

Returns the children of the selected document/folder.

  • $sort should be a comma-separated list of field names on which to sort
  • $direction should be ASC or DESC
  • $limit should be a valid argument to the SQL LIMIT clause.

Examples

Notes

Function Source

Suggest an edit to this page on GitHub (Requires GitHub account. Opens a new window/tab).