Function Module_topics->new_topic

Definitions

forum/pages/modules/topics.php

  • The UI to create a new topic.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$private_topic boolean No No False N/A N/A Whether a new Private Topic is being created
$member_id ?MEMBER No No Null N/A N/A The member ID being whispered too (null: N/A)
$img_path string No No Blank (empty string) N/A N/A Theme image code
$text ?Tempcode No No Null N/A N/A Text of screen (null: none)

Returns

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

Preview

Code (PHP)

/**
 * The UI to create a new topic.
 *
 * @param  boolean $private_topic Whether a new Private Topic is being created
 * @param  ?MEMBER $member_id The member ID being whispered too (null: N/A)
 * @param  string $img_path Theme image code
 * @param  ?Tempcode $text Text of screen (null: none)
 * @return Tempcode The UI
 */

public function new_topic(bool $private_topic = false, ?int $member_id = null, string $img_path = '', ?object $text = null) : object