Function __global->get_screen_title
Definitions
sources/templates.php
- Get the Tempcode for a page title. (Ones below the page header, not in the browser title bar).
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: object
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $title | mixed | required parameter | N/A | N/A | The title to use (usually, a language string codename, see below) |
| $dereference_lang | boolean | True | N/A | N/A | Whether the given title is actually a language string codename, and hence gets dereferenced |
| $params | array | [] | N/A | N/A | Parameters sent to the language string |
| $user_online_title | ?Tempcode | Null | N/A | N/A | Separate title to put into the 'currently viewing' data (null: use $title) |
| $awards | array | [] | N/A | N/A | Awards to say this has won |
| $save_as_metadata | boolean | True | N/A | N/A | Whether to use this as metadata for the screen |
| $sub | ?mixed | Null | N/A | N/A | Sub-title (null: none) |
Return
- The title Tempcode
- Type: Tempcode
- Set: N/A
- Range: N/A