Fieldtype::formatValue() method

Format the given value for output and return a string of the formatted value

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

$mixed = $fieldtype->formatValue(Page $page, Field $field, $value);

Arguments

NameType(s)Description
pagePage

Page that the value lives on

fieldField

Field that represents the value

valuestring, int, object

The value to format

Return value

mixed


Hooking Fieldtype::formatValue(…)

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

$this->addHookBefore('Fieldtype::formatValue', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $Fieldtype = $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 Fieldtype::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('Fieldtype::formatValue', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $Fieldtype = $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;
});

Fieldtype methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #527
    In the 527th issue of ProcessWire Weekly we'll check out what's new in the core this week, introduce a new third party module called Lister Calculator, and more. Read on!
    Weekly.pw / 15 June 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits