Function __global->redirect_screen

Definitions

sources/templates.php

  • Redirect the user - transparently, storing a message that will be shown on their destination page.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$title ?Tempcode No No required parameter N/A N/A Title to display on redirect page (null: standard redirection title)
$url mixed No No required parameter N/A N/A Destination URL (may be Tempcode)
$text ?mixed No No Null N/A N/A Message to show (may be Tempcode) (null: standard redirection message)
$intermediary_hop boolean No No False N/A N/A For intermediary hops, don't mark so as to read status messages - save them up for the next hop (which will not be intermediary)
$msg_type ID_TEXT No No inform warn inform fatal N/A Code of message type to show

Returns

  • Redirection message (likely to not actually be seen due to instant redirection)
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Redirect the user - transparently, storing a message that will be shown on their destination page.
 *
 * @param  ?Tempcode $title Title to display on redirect page (null: standard redirection title)
 * @param  mixed $url Destination URL (may be Tempcode)
 * @param  ?mixed $text Message to show (may be Tempcode) (null: standard redirection message)
 * @param  boolean $intermediary_hop For intermediary hops, don't mark so as to read status messages - save them up for the next hop (which will not be intermediary)
 * @param  ID_TEXT $msg_type Code of message type to show
 * @set warn inform fatal
 * @return Tempcode Redirection message (likely to not actually be seen due to instant redirection)
 */
function redirect_screen(?object $title, $url, $text = null, bool $intermediary_hop = false, string $msg_type = 'inform') : object