FieldtypePageTable::formatValue() method

Return a formatted PageTable value, which is essentially a new PageArray with hidden items removed

Page instances call upon this method to do any necessary formatting of a value in preparation for output, but only if output formatting $page->of() is enabled. The most common use of this method is for text-only fields that need to have some text formatting applied to them, like Markdown, SmartyPants, Textile, etc. As a result, Fieldtype modules don't need to implement this unless it's applicable.

Usage

$items = $fieldtypePageTable->formatValue(Page $page, Field $field, PageArray $value);

Arguments

Name	Type(s)	Description
`page`	Page	Page that the value lives on
`field`	Field	Field that represents the value
`value`	PageArray	The value to format

Return value

PageArray

Hooking FieldtypePageTable::formatValue(…)

You can add your own hook events that are executed either before or after the FieldtypePageTable::formatValue(…) 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 FieldtypePageTable::formatValue(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each FieldtypePageTable::formatValue(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('FieldtypePageTable::formatValue', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $FieldtypePageTable = $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)
  $page = $event->arguments(0);
  $field = $event->arguments(1);
  $value = $event->arguments(2);

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

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

FieldtypePageTable methods and properties

API reference based on ProcessWire core version 3.0.236