Function Module_topics->relay_with_reason

Definitions

forum/pages/modules/topics.php

  • The UI for a trivial form page that asks a reason before relaying the results to the same URL, but with an underscored type.
  • 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 ID_TEXT No No required parameter N/A N/A The language string codename for the title to use in the page
$additional_fields array No No [] N/A N/A Array of additional Tempcode fields to attach after the reason field
$js_function_calls array No No [] N/A N/A Array of JavaScript function calls to use

Returns

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

Preview

Code (PHP)

/**
 * The UI for a trivial form page that asks a reason before relaying the results to the same URL, but with an underscored type.
 *
 * @param  ID_TEXT $_title The language string codename for the title to use in the page
 * @param  array $additional_fields Array of additional Tempcode fields to attach after the reason field
 * @param  array $js_function_calls Array of JavaScript function calls to use
 * @return Tempcode The UI
 */
public function relay_with_reason(string $_title, array $additional_fields = [], array $js_function_calls = []) : object