PageTraversal::links()

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

Usage

// basic usage
$items = $pageTraversal->links(Page $page);

// usage with all arguments
$items = $pageTraversal->links(Page $page, string $selector = '', $field = false, array $options = []);

Arguments

NameType(s)Description
$pagePage
$selector (optional)string
$field (optional)bool string Field
$options (optional)array
  • getIDs (bool): Return array of page IDs rather than Page instances. Default:false
  • getCount (bool): Return a total count (int) of found pages rather than Page instances. Default:false
  • confirm (bool): Confirm that the links are present by looking at the actual page field data. Default:true You can specify false for this option to make it perform faster, but with a potentially less accurate result.

Return value

PageArray array int

Exceptions

Method can throw exceptions on error:

  • WireException


PageTraversal methods and properties

API reference based on ProcessWire core version 3.0.255