Fieldtype::install() method

Install this Fieldtype, consistent with optional Module interface

Called once at time of installation by Modules::install().
If custom Fieldtype classes need to perform any setup beyond that performed in ___createTable(), this method is where they should do it. This is not required, and probably not applicable to most.

Usage

$fieldtype->install();

Exceptions

Method can throw exceptions on error:

WireException - Should throw an Exception on failure to install

Hooking Fieldtype::install()

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

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

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
});

Hooking after

The 'after' hooks are called immediately after each Fieldtype::install() 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::install', 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;

  /* 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.244