$page->links() method

Return pages linking to this one (in Textarea/HTML fields)

Applies only to Textarea fields with “html” content-type and link abstraction enabled.

Available since version 3.0.107.

Usage

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

// usage with all arguments
$items = $page->links($selector = '', $field = '');

Arguments

Name	Type(s)	Description
`selector` (optional)	string, bool	Optional selector to filter by or boolean true for “include=all”. (default='')
`field` (optional)	string, Field	Optionally limit results to specified field. (default=all applicable Textarea fields)

Return value

PageArray

Hooking $page->links(…)

You can add your own hook events that are executed either before or after the $page->links(…) method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each $page->links(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('Page::links', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $page = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $selector = $event->arguments(0);
  $field = $event->arguments(1);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $selector);
  $event->arguments(1, $field);
});

Hooking after

The 'after' hooks are called immediately after each $page->links(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('Page::links', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $page = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  // Get values of arguments sent to hook (if needed)
  $selector = $event->arguments(0);
  $field = $event->arguments(1);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

$page methods and properties

API reference based on ProcessWire core version 3.0.236