Documentation

GenericControls.template.php

Simple Machines Forum (SMF)

Tags
author

Simple Machines https://www.simplemachines.org

copyright

2025 Simple Machines and individual contributors

license

https://www.simplemachines.org/about/smf/license.php BSD

version
3.0

Alpha 2

Table of Contents

Functions

template_control_richedit()  : mixed
This function displays all the stuff you get with a richedit box - BBC, smileys, etc.
template_control_richedit_buttons()  : mixed
This template shows the form buttons at the bottom of the editor
template_control_verification()  : bool
This template displays a verification form

Functions

template_control_richedit()

This function displays all the stuff you get with a richedit box - BBC, smileys, etc.

template_control_richedit(string $editor_id[, null|bool $smileyContainer = null ][, null|bool $bbcContainer = null ]) : mixed
Parameters
$editor_id : string

The editor ID

$smileyContainer : null|bool = null

If null, hides the smiley section regardless of settings

$bbcContainer : null|bool = null

If null, hides the bbcode buttons regardless of settings

template_control_richedit_buttons()

This template shows the form buttons at the bottom of the editor

template_control_richedit_buttons(string $editor_id) : mixed
Parameters
$editor_id : string

The editor ID

template_control_verification()

This template displays a verification form

template_control_verification(int|string $verify_id[, string $display_type = 'all' ][, bool $reset = false ]) : bool
Parameters
$verify_id : int|string

The verification control ID

$display_type : string = 'all'

What type to display. Can be 'single' to only show one verification option or 'all' to show all of them

$reset : bool = false

Whether to reset the internal tracking counter

Return values
bool

False if there's nothing else to show, true if $display_type is 'single', nothing otherwise


        
On this page

Search results