users($selector = '') function
Get, find or save users ($users API variable as a function)
permissions($selector = '') function
Get, find or save permissions ($permissions API variable as a function)
roles($selector = '') function
Get, find or save roles ($roles API variable as a function)
Selector module
Build a page finding selector visually.
Lister module
Admin tool for finding and listing pages by any property.
$classLoader->findClassFile(string $className) apivar.method
Find filename for given class name (primarily for API testing/debugging purposes)
$files->find(string $path, array $options = []) apivar.method
Find all files in the given $path recursively, and return a flat array of all found filenames
$modules->findByPrefix(string $prefix, $load = false) apivar.method
Find modules matching the given prefix (i.e. “Inputfield”)
$modules->findByInfo($selector, $load = false) apivar.method
Find modules by matching a property or properties in their module info
$forms->findEntries(string $keywords, string $operator = '*=', $form = 0) apivar.method
Find form entries across all forms (or on specific form if specified)
$fields->findByTag(string $tag, bool $getFieldNames = false) apivar.method
Return all fields that have the given $tag
$fields->findByType($type, array $options = []) apivar.method
Find fields by type
$pages->find($selector, $options = []) apivar.method
Given a Selector string, return the Page objects that match in a PageArray.
$pages->findOne($selector, $options = []) apivar.method
Like find() but returns only the first match as a Page object (not PageArray).
$pages->findMany($selector, array $options = []) apivar.method
Like find(), but with “lazy loading” to support giant result sets without running out of memory.
$pages->findJoin($selector, $joinFields, array $options = []) apivar.method
Find pages and specify which fields to join (overriding configured autojoin settings)
$pages->findIDs($selector, $options = []) apivar.method
Like find() except returns array of IDs rather than Page objects
$pages->findRaw($selector, $field = '', array $options = []) apivar.method
Find pages and return raw data from them in a PHP array
$pages->pathFinder() apivar.method
Get the PagesPathFinder instance
$pages->found(PageArray $pages, array $details) apivar.method
Hook called at the end of a $pages->find(), includes extra info not seen in the resulting PageArray
find($selector) apivar.method
Return the permissions(s) matching the the given selector query.
find($selector) apivar.method
Return the Role(s) matching the the given selector.
find($selector) apivar.method
Return the User(s) matching the the given selector query.
$page->find($selector = '', array $options = []) apivar.method
Find descendant pages matching given selector
$page->findOne($selector = '', array $options = []) apivar.method
Find one descendant page matching given selector