Function __global->inform_screen

Definitions

sources/templates.php

  • Get the Tempcode for an info 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 The title of the info page
$text mixed No No required parameter N/A N/A The text to put on the info page, provided in plain-text format or as HTML via do_lang_tempcode/protect_from_escaping (string or Tempcode)
$support_match_key_messages boolean No No False N/A N/A Whether match key messages / redirects should be supported
$back_url ?Tempcode No No Null N/A N/A URL to have back button to (null: none)
$fields ?Tempcode No No Null N/A N/A Fields to carry with on back button (null: none)

Returns

  • The info page
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get the Tempcode for an info page.
 *
 * @param  Tempcode $title The title of the info page
 * @param  mixed $text The text to put on the info page, provided in plain-text format or as HTML via do_lang_tempcode/protect_from_escaping (string or Tempcode)
 * @param  boolean $support_match_key_messages Whether match key messages / redirects should be supported
 * @param  ?Tempcode $back_url URL to have back button to (null: none)
 * @param  ?Tempcode $fields Fields to carry with on back button (null: none)
 * @return Tempcode The info page
 */
function inform_screen(object $title, $text, bool $support_match_key_messages = false, ?object $back_url = null, ?object $fields = null) : object