Function __global->verify_unsunscribe_hash

Definitions

sources/newsletter.php

  • Verify the provided unsubscribe hash is valid.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: bool

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$provided_hash string No No required parameter N/A N/A The hash provided
$hash string No No required parameter N/A N/A Subscriber hash or password

Returns

  • Whether the hash is valid
  • Type: boolean
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Verify the provided unsubscribe hash is valid.
 *
 * @param  string $provided_hash The hash provided
 * @param  string $hash Subscriber hash or password
 * @return boolean Whether the hash is valid
 */
function verify_unsunscribe_hash(string $provided_hash, string $hash) : bool