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).
  • 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 mixed No No required parameter N/A N/A The title to use (usually, a language string codename, see below)
$dereference_lang boolean No No True N/A N/A Whether the given title is actually a language string codename, and hence gets dereferenced
$params array No No [] N/A N/A Parameters sent to the language string
$user_online_title ?Tempcode No No Null N/A N/A Separate title to put into the 'currently viewing' data (null: use $title)
$awards array No No [] N/A N/A Awards to say this has won
$save_as_metadata boolean No No True N/A N/A Whether to use this as metadata for the screen
$sub ?mixed No No Null N/A N/A Sub-title (null: none)

Returns

  • The title Tempcode
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get the Tempcode for a page title. (Ones below the page header, not in the browser title bar).
 *
 * @param  mixed $title The title to use (usually, a language string codename, see below)
 * @param  boolean $dereference_lang Whether the given title is actually a language string codename, and hence gets dereferenced
 * @param  array $params Parameters sent to the language string
 * @param  ?Tempcode $user_online_title Separate title to put into the 'currently viewing' data (null: use $title)
 * @param  array $awards Awards to say this has won
 * @param  boolean $save_as_metadata Whether to use this as metadata for the screen
 * @param  ?mixed $sub Sub-title (null: none)
 * @return Tempcode The title Tempcode
 */
function get_screen_title($title, bool $dereference_lang = true, array $params = [], ?object $user_online_title = null, array $awards = [], bool $save_as_metadata = true, $sub = null) : object