Function __global->redirect_screen
Definitions
sources/templates.php
- Redirect the user - transparently, storing a message that will be shown on their destination page.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: object
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $title | ?Tempcode | required parameter | N/A | N/A | Title to display on redirect page (null: standard redirection title) |
| $url | mixed | required parameter | N/A | N/A | Destination URL (may be Tempcode) |
| $text | ?mixed | Null | N/A | N/A | Message to show (may be Tempcode) (null: standard redirection message) |
| $intermediary_hop | boolean | 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 | inform | N/A | N/A | Code of message type to show |
Return
- Redirection message (likely to not actually be seen due to instant redirection)
- Type: Tempcode
- Set: N/A
- Range: N/A