$page->siblings() method

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

To exclude the current page in list of siblings, specify boolean false for first or second argument.

Example

// Get all sibling pages 
$siblings = $page->siblings();

// Get all sibling pages, and exclude current page from the returned value
$siblings = $page->siblings(false);

// Get all siblings having the "product-featured" template, sorted by name
$featured = $page->siblings("template=product-featured, sort=name");

// Same as above, while excluding current page
$featured = $page->siblings("template=product-featured, sort=name", false);

Usage

// basic usage
$items = $page->siblings();

// usage with all arguments
$items = $page->siblings($selector = '', bool $includeCurrent = true);

Arguments

NameType(s)Description
selector (optional)string, array, bool

Optional selector to filter siblings by, or omit for all siblings.

includeCurrent (optional)bool

Specify false to exclude current page in the returned siblings (default=true). If no $selector argument is given, this argument may optionally be specified as the first argument.

Return value


$page methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #532
    In the 532nd issue of ProcessWire Weekly we'll cover the latest core updates, check out a couple of brand-new third party modules, and more. Read on!
    Weekly.pw / 20 July 2024
  • Page List Custom Children module
    This simple module gives you the ability to customize the parent/child relationship as it appears in the admin page list, enabling child pages to appear under more than one parent.
    Blog / 28 June 2024
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer