ProMailerForms::getUnsubscribeUrl() method

Return URL to an unsubscribe form

Usage

// basic usage
$string = $proMailerForms->getUnsubscribeUrl(ProMailerSubscriber $subscriber);

// usage with all arguments
$string = $proMailerForms->getUnsubscribeUrl(ProMailerSubscriber $subscriber, $options = []);

Arguments

Name	Type(s)	Description
`subscriber`	ProMailerSubscriber
`options` (optional)	array, bool	`queryStringOnly` (bool): Only return the query string? (default=false) `requireHttps` (bool): Require that returned URL uses https scheme? (default=false) If given boolean for $options, the queryStringOnly option is assumed.

Return value

string

Hooking ProMailerForms::getUnsubscribeUrl(…)

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

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

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