Function __global->cancel_all_escrows_by_content

Definitions

sources/points_escrow.php

  • Cancel all escrows associated with the given content type and ID.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$content_type ID_TEXT No No required parameter N/A N/A The content type to search
$content_id ID_TEXT No No required parameter N/A N/A The content ID to search
$reason LONG_TEXT No No required parameter N/A N/A The reason for cencelling these escrows

Returns

  • Array of AUTO_LINK escrow IDs cancelled mapped to their ?AUTO_LINK point ledger
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Cancel all escrows associated with the given content type and ID.
 *
 * @param  ID_TEXT $content_type The content type to search
 * @param  ID_TEXT $content_id The content ID to search
 * @param  LONG_TEXT $reason The reason for cencelling these escrows
 * @return array Array of AUTO_LINK escrow IDs cancelled mapped to their ?AUTO_LINK point ledger
 */

function cancel_all_escrows_by_content(string $content_type, string $content_id, string $reason) : array