Documentation

index.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_init()  : mixed
Initialize the template... mainly little settings.
template_html_above()  : mixed
The main sub template above the content.
template_body_above()  : mixed
The upper part of the main template layer. This is the stuff that shows above the main forum content.
template_body_below()  : mixed
The stuff shown immediately below the main content, including the footer
template_html_below()  : mixed
This shows any deferred JavaScript and closes out the HTML
theme_linktree()  : mixed
Show a linktree. This is that thing that shows "My Community | General Category | General Discussion".
template_menu()  : mixed
Show the menu up top. Something like [home] [help] [profile] [logout].
template_button_strip()  : mixed
Generate a strip of buttons.
template_quickbuttons()  : void|string
Generate a list of quickbuttons.
template_maint_warning_above()  : mixed
The upper part of the maintenance warning box
template_maint_warning_below()  : mixed
The lower part of the maintenance warning box.
template_security_warning_above()  : mixed
The upper part of the security warning box
template_security_warning_below()  : mixed
The lower part of the security warning box.
template_banned_warning_above()  : mixed
The upper part of the ban warning box
template_banned_warning_below()  : mixed
The lower part of the ban warning box.

Functions

template_init()

Initialize the template... mainly little settings.

template_init() : mixed

template_html_above()

The main sub template above the content.

template_html_above() : mixed

template_body_above()

The upper part of the main template layer. This is the stuff that shows above the main forum content.

template_body_above() : mixed

template_body_below()

The stuff shown immediately below the main content, including the footer

template_body_below() : mixed

template_html_below()

This shows any deferred JavaScript and closes out the HTML

template_html_below() : mixed

theme_linktree()

Show a linktree. This is that thing that shows "My Community | General Category | General Discussion".

theme_linktree([bool $force_show = false ]) : mixed

.

Parameters
$force_show : bool = false

Whether to force showing it even if settings say otherwise

template_menu()

Show the menu up top. Something like [home] [help] [profile] [logout].

template_menu() : mixed

..

template_button_strip()

Generate a strip of buttons.

template_button_strip(array<string|int, mixed> $button_strip[, string $direction = '' ][, array<string|int, mixed> $strip_options = array() ]) : mixed
Parameters
$button_strip : array<string|int, mixed>

An array with info for displaying the strip

$direction : string = ''

The direction

$strip_options : array<string|int, mixed> = array()

Options for the button strip

template_quickbuttons()

Generate a list of quickbuttons.

template_quickbuttons(array<string|int, mixed> $list_items[, string $list_class = null ][, string $output_method = 'echo' ]) : void|string
Parameters
$list_items : array<string|int, mixed>

An array with info for displaying the strip

$list_class : string = null

Used for integration hooks and as a class name

$output_method : string = 'echo'

The output method. If 'echo', simply displays the buttons, otherwise returns the HTML for them

Return values
void|string

Returns nothing unless output_method is something other than 'echo'

template_maint_warning_above()

The upper part of the maintenance warning box

template_maint_warning_above() : mixed

template_maint_warning_below()

The lower part of the maintenance warning box.

template_maint_warning_below() : mixed

template_security_warning_above()

The upper part of the security warning box

template_security_warning_above() : mixed

template_security_warning_below()

The lower part of the security warning box.

template_security_warning_below() : mixed

template_banned_warning_above()

The upper part of the ban warning box

template_banned_warning_above() : mixed

template_banned_warning_below()

The lower part of the ban warning box.

template_banned_warning_below() : mixed

        
On this page

Search results