FieldtypeFieldsetOpen::getCompatibleFieldtypes() method

Get an array of Fieldtypes that are compatible with this one

This represents the list of Fieldtype modules that the user is allowed to change to from this one.

Usage

$fieldtypeFieldsetOpen->getCompatibleFieldtypes($field);

Arguments

NameType(s)Description
fieldField

Return value

Fieldtypes null


Hooking FieldtypeFieldsetOpen::getCompatibleFieldtypes(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

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

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

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

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

FieldtypeFieldsetOpen methods and properties

API reference based on ProcessWire core version 3.0.244

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer