Function __global->generate_dload_url

Definitions

sources/downloads.php

  • Generate a link to a site download.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$id AUTO_LINK No No required parameter N/A N/A The ID of the download to be downloaded
$use_gateway boolean No No required parameter N/A N/A Whether to use the gateway script

Returns

  • The URL
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Generate a link to a site download.
 *
 * @param  AUTO_LINK $id The ID of the download to be downloaded
 * @param  boolean $use_gateway Whether to use the gateway script
 * @return Tempcode The URL
 */
function generate_dload_url(int $id, bool $use_gateway) : object