Function __global->get_temporary_upload_path

Definitions

sources/uploads.php

  • Take an uploaded file and move it into the software's temporary directory, for future processing outside this web request.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: string

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$attach_name string No No required parameter N/A N/A Field name
$prepend_session_id boolean No No False N/A N/A Prepend the current session ID to the beginning of the filename without returning it in the path (security), 'sessioning'
&$unsessioned_filename ?string Yes No Null N/A N/A The unsessioned filename (null: not set yet)

Returns

  • Upload path
  • Type: PATH
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Take an uploaded file and move it into the software's temporary directory, for future processing outside this web request.
 *
 * @param  string $attach_name Field name
 * @param  boolean $prepend_session_id Prepend the current session ID to the beginning of the filename without returning it in the path (security), 'sessioning'
 * @param  ?string $unsessioned_filename The unsessioned filename (null: not set yet)
 * @return PATH Upload path
 */
function get_temporary_upload_path(string $attach_name, bool $prepend_session_id = false, ?string &$unsessioned_filename = null) : string