Function __global->get_posting_form

Definitions

sources/form_templates.php

  • Creates a posting form, with attachment support.
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Return: object

Parameters

Name Type Default Set Range Description
$submit_name mixed required parameter N/A N/A The title of the form submission button, provided in plain-text format (string or Tempcode)
$submit_icon ID_TEXT required parameter N/A N/A The submit icon CSS class
$post LONG_TEXT required parameter N/A N/A The default post to put in
$post_url mixed required parameter N/A N/A Where the form is sent (URLPATH or Tempcode)
$hidden_fields Tempcode required parameter N/A N/A A form_input_hidden buildup of hidden fields (additional parameters sent to the target URL)
$specialisation Tempcode required parameter N/A N/A A buildup of leading extra fields, in a format compatible with the templates used by this function
$post_comment ?mixed Null N/A N/A The post comment (string or Tempcode). This gives information about how you should post. (null: no post comment)
$extra string Blank (empty string) N/A N/A Extra info to put on the posting form
$specialisation2 ?Tempcode Null N/A N/A A buildup of trailing extra fields, in a format compatible with the templates used by this function. (null: none)
$default_parsed ?Tempcode Null N/A N/A The parsed Comcode. (null: calculate)
$js_function_calls array [] N/A N/A JavaScript functions to execute
$tabindex ?integer Null N/A N/A The tab index of the field (null: not specified)
$required boolean True N/A N/A Whether this is a required input field
$has_preview boolean True N/A N/A Whether the form supports previewing
$support_wysiwyg boolean True N/A N/A Whether to support WYSIWYG mode
$support_autosave boolean True N/A N/A Whether to support auto-save
$specialisation2_hidden boolean False N/A N/A Whether to hide trailing extra fields
$description mixed Blank (empty string) N/A N/A A description for this input field, provided in HTML format (string or Tempcode)
$cancel_url ?Tempcode Null N/A N/A Cancel URL for cancelling auto-save (null: no cancel button)
$staff_help_url ?mixed Null N/A N/A URL staff can go to to get help (null: none)

Return

  • The posting form
  • Type: Tempcode
  • Set: N/A
  • Range: N/A