Function __global->assign_refresh

Definitions

sources/site2.php

  • Assign a page refresh to the specified URL.This is almost always used within the redirect_screen function.It assumes the software will output a full HTML screen. If you're not outputting HTML, use header('Location: ...');
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$url mixed No No required parameter N/A N/A Refresh to this URL (URLPATH or Tempcode URL)
$multiplier float No No 0 N/A N/A Take this many times longer than a 'standard software refresh' which is 2.5 seconds; will only apply if doing a meta refresh as approach to a redirect header

Preview

Code (PHP)

/**
 * Assign a page refresh to the specified URL.This is almost always used within the redirect_screen function.It assumes the software will output a full HTML screen. If you're not outputting HTML, use header('Location: ...');
 *
 * @param  mixed $url Refresh to this URL (URLPATH or Tempcode URL)
 * @param  float $multiplier Take this many times longer than a 'standard software refresh' which is 2.5 seconds; will only apply if doing a meta refresh as approach to a redirect header
 */

function assign_refresh($url, float $multiplier = 0)