PageTraversal class

Provides implementation for Page traversal functions.

Based upon the jQuery traversal functions.


Click any linked item for full usage details and examples. Hookable methods are indicated with the icon.

Show class?     Show args?       Only hookable?    

Common

NameReturnSummary 
PageTraversal::child(Page $page)
Page NullPage

Return the page's first single child that matches the given selector.

 
PageTraversal::children(Page $page)
PageArray

Return this page's children pages, optionally filtered by a selector

 
PageTraversal::editUrl(Page $page)
string

Return the URL necessary to edit page

 
PageTraversal::hasLinks(Page $page)
array int PageArray

Return total number of pages visible to current user linking to this one

 
PageTraversal::hasReferences(Page $page)
int array

Return number of VISIBLE pages that are following (referencing) the given one by way of Page references

 
PageTraversal::httpUrl(Page $page)
string

Returns the URL to the page, including scheme and hostname

 
PageTraversal::index(Page $page)
int

Return the index/position of the given page relative to its siblings

 
PageTraversal::links(Page $page)
PageArray array int

Find other pages linking to the given one by way contextual links is textarea/html fields

 
PageTraversal::next(Page $page)
Page NullPage

Return the next sibling page

 
PageTraversal::nextAll(Page $page)
PageArray

Return all sibling pages after this one, optionally matching a selector

 
PageTraversal::nextAllSiblings(Page $page)
PageArray

Return all sibling pages after this one, optionally matching a selector

 
PageTraversal::nextSibling(Page $page)
Page NullPage

Return the next sibling page, within a group of provided siblings (that includes the current page)

 
PageTraversal::nextUntil(Page $page)
PageArray

Return all sibling pages after this one until matching the one specified

 
PageTraversal::nextUntilSiblings(Page $page)
PageArray

Return all sibling pages after this one until matching the one specified

 
PageTraversal::numChildren(Page $page)
int

Return number of children, optionally with conditions

 
PageTraversal::numDescendants(Page $page)
int

Return number of descendants, optionally with conditions

 
PageTraversal::numLinks(Page $page)
int

Return total found number of pages linking to this one with no exclusions

 
PageTraversal::numParents(Page $page)
int

Return number of parents (depth relative to homepage) that this page has, optionally filtered by a selector

 
PageTraversal::numReferences(Page $page)
int array

Return number of ANY pages that are following (referencing) the given one by way of Page references

 
PageTraversal::numReferencing(Page $page)
int array

Return number of pages this one is following (referencing) by way of Page references

 
PageTraversal::parents(Page $page)
PageArray

Return this page's parent pages, or the parent pages matching the given selector.

 
PageTraversal::parentsUntil(Page $page)
PageArray

Return all parent from current till the one matched by $selector

 
PageTraversal::prev(Page $page)
Page NullPage

Return the previous sibling page

 
PageTraversal::prevAll(Page $page)
PageArray

Return all sibling pages prior to this one, optionally matching a selector

 
PageTraversal::prevAllSiblings(Page $page)
PageArray

Return all sibling pages before this one, optionally matching a selector

 
PageTraversal::prevSibling(Page $page)
Page NullPage

Return the previous sibling page within a provided group of siblings that contains the current page

 
PageTraversal::prevUntil(Page $page)
PageArray

Return all sibling pages prior to this one until matching the one specified

 
PageTraversal::prevUntilSiblings(Page $page)
PageArray

Return all sibling pages before this one until matching the one specified

 
PageTraversal::references(Page $page)
PageArray array int

Return pages that are referencing the given one by way of Page references

 
PageTraversal::referencing(Page $page)
PageArray int array

Return pages that this page is referencing by way of Page reference fields

 
PageTraversal::rootParent(Page $page)
Page

Get the lowest-level, non-homepage parent of this page

 
PageTraversal::siblings(Page $page)
PageArray

Return this Page's sibling pages, optionally filtered by a selector.

 
PageTraversal::urlOptions(Page $page)
string

Returns the URL to the page with $options

 
PageTraversal::urls(Page $page)
array

Return all URLs that this page can be accessed from (excluding URL segments and pagination)

 

API reference based on ProcessWire core version 3.0.255