PageTraversal::index()

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

If given a hidden or unpublished page, that page would not usually be part of the group of siblings. As a result, such pages will return what the value would be if they were visible (as of 3.0.121. This may overlap with the index of other pages, since indexes are relative to visible pages, unless you specify an include mode (see next paragraph).

If you want this method to include hidden/unpublished pages as part of the index numbers, then specify boolean true for the $selector argument (which implies "include=all") OR specify a selector of "include=hidden", "include=unpublished" or "include=all".

Usage

// basic usage
$int = $pageTraversal->index(Page $page);

// usage with all arguments
$int = $pageTraversal->index(Page $page, $selector = '');

Arguments

Name Type(s) Description

$page Page

Name	Type(s)	Description
`$page`	`Page`
`$selector` (optional)	`string` `array` `bool` `Selectors`	Selector to apply or boolean true for "include=all" 3.0.121. Boolean true to include hidden and unpublished pages as part of the index numbers (same as "include=all"). An "include=hidden", "include=unpublished" or "include=all" selector to include them in the index numbers. A string selector or selector array to filter the criteria for the returned index number.

$selector (optional)

string array bool Selectors

Selector to apply or boolean true for "include=all" 3.0.121.

Boolean true to include hidden and unpublished pages as part of the index numbers (same as "include=all").
An "include=hidden", "include=unpublished" or "include=all" selector to include them in the index numbers.
A string selector or selector array to filter the criteria for the returned index number.

Return value

int

Returns index number (zero-based)

PageTraversal methods and properties

API reference based on ProcessWire core version 3.0.255