FieldtypePassword::getCompatibleFieldtypes() method

Return all Fieldtypes derived from FieldtypeText, which we will consider compatible

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

Usage

$array = $fieldtypePassword->getCompatibleFieldtypes(Field $field);

Arguments

NameType(s)Description
fieldField

Return value

null array


Hooking FieldtypePassword::getCompatibleFieldtypes(…)

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

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

FieldtypePassword methods and properties

API reference based on ProcessWire core version 3.0.244

Latest news

  • ProcessWire Weekly #560
    In the 560th issue of ProcessWire Weekly we'll check out the latest core updates, cover newly released ProcessWire modules, and more. Read on!
    Weekly.pw / 1 February 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.