ProMailerForms::getSubscribePage() method

Get the ProMailer page that handles subscribe and unsubscribe

Usage

// basic usage
$page = $proMailerForms->getSubscribePage();

// usage with all arguments
$page = $proMailerForms->getSubscribePage(bool $allowCreate = true);

Arguments

Name	Type(s)	Description
`allowCreate` (optional)	bool	Create if not exists? (default=true)

Return value

Page NullPage

Hooking ProMailerForms::getSubscribePage(…)

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each ProMailerForms::getSubscribePage(…) 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::getSubscribePage', 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)
  $allowCreate = $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.236