Function __global->get_comcode_editor

Definitions

sources/form_templates.php

  • Creates a Comcode editor.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$field_name string No No post N/A N/A The name of the field the editor is working for
$cut_down boolean No No False N/A N/A Whether to make a cut-down version
$is_posting_field boolean No No False N/A N/A Whether this is for a posting field (i.e. has attachment support)

Returns

  • The Comcode editor
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Creates a Comcode editor.
 *
 * @param  string $field_name The name of the field the editor is working for
 * @param  boolean $cut_down Whether to make a cut-down version
 * @param  boolean $is_posting_field Whether this is for a posting field (i.e. has attachment support)
 * @return Tempcode The Comcode editor
 */
function get_comcode_editor(string $field_name = 'post', bool $cut_down = false, bool $is_posting_field = false) : object