FieldtypeText::formatValue()

Format value for output

Usage

$string = $fieldtypeText->formatValue(Page $page, Field $field, string $value);

Arguments

NameType(s)Description
$pagePage
$fieldField
$valuestring

Return value

string


Hooking FieldtypeText::formatValue(…)

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

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

FieldtypeText methods and properties

API reference based on ProcessWire core version 3.0.255