ProMailerForms::getUnsubscribeField() method

Get the Field that has a non-zero value if user is unsubscribed from a pages list

Applies only to pages lists!

This method also creates a generic promailer_unsubscribe field if none exists, and adds the field to any relevant fieldgroups.

Usage

// basic usage
$field = $proMailerForms->getUnsubscribeField(ProMailerList $list);

// usage with all arguments
$field = $proMailerForms->getUnsubscribeField(ProMailerList $list, bool $allowCreate = true, bool $allowAddTemplates = true);

Arguments

Name	Type(s)	Description
`list`	ProMailerList
`allowCreate` (optional)	bool	Create it if it does not exist? (default=true)
`allowAddTemplates` (optional)	bool	Allow adding it to templates? (default=true)

Return value

Field null

Hooking ProMailerForms::getUnsubscribeField(…)

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

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

  // Get values of arguments sent to hook (and optionally modify them)
  $list = $event->arguments(0);
  $allowCreate = $event->arguments(1);
  $allowAddTemplates = $event->arguments(2);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $list);
  $event->arguments(1, $allowCreate);
  $event->arguments(2, $allowAddTemplates);
});

Hooking after

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

$this->addHookAfter('ProMailerForms::getUnsubscribeField', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $ProMailerForms = $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)
  $list = $event->arguments(0);
  $allowCreate = $event->arguments(1);
  $allowAddTemplates = $event->arguments(2);

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

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

ProMailerForms methods and properties

API reference based on ProcessWire core version 3.0.244