Function Module_admin_cns_forums->get_form_fields

Definitions

adminzone/pages/modules/admin_cns_forums.php

  • Get Tempcode for a forum adding/editing form.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Return: array

Parameters

Name Type Default Set Range Description
$id ?AUTO_LINK Null N/A N/A The ID of the forum being edited (null: adding, not editing)
$name SHORT_TEXT Blank (empty string) N/A N/A The name of the forum
$description LONG_TEXT Blank (empty string) N/A N/A The description of the forum
$forum_grouping_id ?AUTO_LINK Null N/A N/A The ID of the forum grouping for the forum (null: first)
$parent_forum ?AUTO_LINK Null N/A N/A The parent forum (null: root)
$position ?integer Null N/A N/A The position (null: next)
$post_count_increment BINARY 1 N/A N/A Whether post counts are incremented in this forum
$order_sub_alpha BINARY 0 N/A N/A Whether subforums are ordered alphabetically (instead of manually)
$intro_question LONG_TEXT Blank (empty string) N/A N/A Introductory question posed to all newcomers to the forum
$intro_answer LONG_TEXT Blank (empty string) N/A N/A Answer to the introductory question (or blank if it was just an 'ok')
$redirection SHORT_TEXT Blank (empty string) N/A N/A Redirection code (blank implies a normal forum, not a redirector)
$order ID_TEXT last_post N/A N/A The order the topics are shown in, by default
$is_threaded BINARY 0 N/A N/A Whether the forum is threaded
$allows_anonymous_posts BINARY 1 N/A N/A Whether anonymous posts are allowed
$mail_email_address EMAIL Blank (empty string) N/A N/A Mailing list e-mail address (blank: not set / use centrally configured)
$mail_server_type SHORT_TEXT Blank (empty string) N/A N/A Mailing list server type (blank: not set / use centrally configured)
$mail_server_host SHORT_TEXT Blank (empty string) N/A N/A Mailing list server host (blank: not set / use centrally configured)
$mail_server_port ?integer Null N/A N/A Mailing list server port (null: not set / use centrally configured)
$mail_folder SHORT_TEXT Blank (empty string) N/A N/A Mailing list folder (blank: not set)
$mail_username SHORT_TEXT Blank (empty string) N/A N/A Mailing list username (blank: not set)
$mail_password SHORT_TEXT Blank (empty string) N/A N/A Mailing list password (blank: not set / use centrally configured)
$mail_nonmatch_policy ID_TEXT post_as_guest N/A N/A Mailing list policy for non-matched users
$mail_unconfirmed_notice BINARY 1 N/A N/A Mailing list policy: whether to highlight that members are not fully confirmed
$poll_default_options_xml LONG_TEXT Blank (empty string) N/A N/A XML which defines enforced options for polls within this forum

Return

  • A pair: The input fields, Hidden fields
  • Type: array
  • Set: N/A
  • Range: N/A