FieldtypeModule::markupValue() method

Render a markup string of the value.

Non-markup components should also be entity encoded where appropriate.

Most Fieldtypes don't need to implement this since the default covers most scenarios.

This is different from Fieldtype::formatValue() in that it always returns a string (or object that can be typecast to a string) that is output ready with markup. Further, this method may be used to render specific properties in compound Fieldtypes. The intention here is primarily for admin output purposes, but can be used front-end where applicable.

This is different from Inputfield::renderValue() in that the context may be outside that of an Inputfield, as Inputfields can have external CSS or JS dependencies.

Usage

// basic usage
$string = $fieldtypeModule->markupValue(Page $page, Field $field);

// usage with all arguments
$string = $fieldtypeModule->markupValue(Page $page, Field $field, mixed $value = null, string $property = '');

Arguments

Name	Type(s)	Description
`page`	Page	Page that $value comes from
`field`	Field	Field that $value comes from
`value` (optional)	mixed	Optionally specify the value returned by `$page->getFormatted('field')`. When specified, value must be a formatted value. If null or not specified (recommended), it will be retrieved automatically.
`property` (optional)	string	Optionally specify the property or index to render. If omitted, entire value is rendered.

Return value

string

Returns a string or object that can be output as a string, ready for output. Return a MarkupFieldtype value when suitable so that the caller has potential specify additional config options before typecasting it to a string.

Hooking FieldtypeModule::markupValue(…)

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

$this->addHookBefore('FieldtypeModule::markupValue', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $FieldtypeModule = $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);
  $property = $event->arguments(3);

  /* 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);
  $event->arguments(3, $property);
});

Hooking after

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

$this->addHookAfter('FieldtypeModule::markupValue', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $FieldtypeModule = $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);
  $property = $event->arguments(3);

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

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

FieldtypeModule methods and properties

API reference based on ProcessWire core version 3.0.244