ProMailerForms::unsubscribe()

Render or process an un-subscribe form at URL clicked from an email

Requires that the URL contains these valid GET variables below that match the subscribers record. You can get this URL by calling the getUnsubscribeUrl() method.

unsub (int): ID of the list to unsubscribe from.
email (string): Email address to unsubscribe.
code (string): Authentication code stored with subscriber.

If any of the above variables are not present or incorrect, an error message will be returned.

Usage

// basic usage
$string = $proMailerForms->unsubscribe();

// usage with all arguments
$string = $proMailerForms->unsubscribe(array $options = []);

Arguments

Name	Type(s)	Description
`$options` (optional)	`array`

Return value

string

Hooking ProMailerForms::unsubscribe(…)

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

$this->addHookBefore('ProMailerForms::unsubscribe', 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)
  $options = $event->arguments(0);

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each ProMailerForms::unsubscribe(…) 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::unsubscribe', 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)
  $options = $event->arguments(0);

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