SSI.php Functions

Current Version: 2.0 dev

This file is used to demonstrate the capabilities of SSI.php using PHP include functions. The examples show the include tag, then the results of it.

Include Code

To use SSI.php in your page add at the very top of your page before the <html> tag on line 1 of your php file:

[Select] 
<?php require("SSI.php");

Some notes on usage

All the functions have an output method parameter. This can either be "echo" (the default) or "array"

If it is "echo", the function will act normally - otherwise, it will return an array containing information about the requested task. For example, it might return a list of topics for ssi_recentTopics.

This functionality can be used to allow you to present the information in any way you wish.

Additional Guides & FAQ

Need more information on using SSI.php? Check out Using SSI.php article or ask on the forum.

Function List

Recent Items

Top Items

Members

Authentication

Calendar

Miscellaneous

Website Samples

Other

Recent Topics Function

Code (simple mode)

[Select] 
<?php ssi_recentTopics();

Code (advanced mode)

[Select] 
<?php ssi_recentTopics($num_recent = 8, $exclude_boards = null, $include_boards = null, $output_method = 'echo');

Result

[Addons ideas and questions] Updated Spider List by Burke Knight May 03, 2025, 07:58:27 pm
[Support] Text view by Steeley May 03, 2025, 10:25:41 am
[Support] Antechinus needs help logging in! by Spuds April 22, 2025, 05:52:55 pm
[Addons] Simple Audio Video Embedder - 90+ Sites by vbgamer45 April 08, 2025, 12:34:03 am
[Bug Reports] can't to to the main page after installation please help. by Xarzu March 26, 2025, 03:24:40 am
[General ElkArte discussions] Email on bithday by radu81 March 03, 2025, 05:14:15 pm
[General ElkArte discussions] Embedding self hosted videos by Hectraph February 20, 2025, 03:34:07 pm
[Support] AI Chatbot by Steeley January 29, 2025, 03:38:09 pm

Recent Posts Function

Code

[Select] 
<?php ssi_recentPosts();

Result

[Addons ideas and questions] Re: Updated Spider List by Burke Knight May 03, 2025, 07:58:27 pm
[Addons ideas and questions] Re: Updated Spider List by Spuds May 03, 2025, 04:27:51 pm
[Support] Re: Text view by Steeley May 03, 2025, 10:25:41 am
[Support] Re: Text view by Spuds May 02, 2025, 09:53:52 pm
[Support] Re: Text view by Steeley May 02, 2025, 09:45:48 pm
[Support] Re: Text view by Spuds May 02, 2025, 05:25:41 pm
[Support] Re: Text view by Fiera May 02, 2025, 09:10:33 am
[Addons ideas and questions] Re: Updated Spider List by Burke Knight April 30, 2025, 11:06:18 am

Recent Poll Function

Code

[Select] 
<?php ssi_recentPoll();

Result

Top Boards Function

Shows top boards by the number of posts.

Code

[Select] 
<?php ssi_topBoards();

Result

Board Topics Posts
New Exterminated Bugs 780 6,153
New Support 767 6,101
New Feature Discussion 622 5,242
New General ElkArte discussions 337 3,871
New Addons 168 3,816
New Chit Chat 383 3,572
New Theme development 237 2,096
New Exterminated Features 187 1,962
New Bug Reports 197 1,687
New Site Feedback 135 1,677

Top Topics

Shows top topics by the number of replies or views.

Code (show by number of views)

[Select] 
<?php ssi_topTopicsViews();

Result

Views Replies
[ADDON] SimplePortal 490,378 642
Quote to an existing topic [was: Re: Quote to new topic] 457,616 4
Quote to new topic 425,238 14
EARLY Beta version of 2.0 299,150 120
[ADDON][beta] Topic Prefix 247,556 99
Hello! 226,367 152
ElkArte 1.1.9 - Release Announcement 203,083 7
IRC 189,230 380
Largest ElkArte boards? 186,054 56
ElkArte 1.1.6 - Release announcement 165,133 28

Code (show by number of replies)

[Select] 
<?php ssi_topTopicsReplies();

Result

Views Replies
[ADDON] SimplePortal 490378 642
IRC 189230 380
OpenImporter 100967 212
BBC Parsing 72968 185
New menu arrangement: Community - Staff - Personal 96549 163
Hello! 226367 152
[ADDON] Levertine Gallery 142164 149
Stress relief 130681 133
Convert SMF to ElkArte 81950 125
ElkArte 1.1.7 Patch Testing 107813 124

Top Poll Function

Shows the most-voted-in poll.

Code

[Select] 
<?php ssi_topPoll();

Result

Top Poster Function

Shows the top poster's name and profile link.

Code

[Select] 
<?php ssi_topPoster();

Result

emanuele

Latest Member Function

Shows the latest member's name and profile link.

Code

[Select] 
<?php ssi_latestMember();

Result

Please welcome Fiera, our newest member.

Member of the Day

Shows one random member of the day. This changes once a day.

Code

[Select] 
<?php ssi_randomMember('day');

Result

GOD
GOD

Who's Online Function

This function shows who are online inside the forum.

Code

[Select] 
<?php ssi_whosOnline();

Result

116 Guests, 0 Users

Log Online Presence

This function logs the SSI page's visitor, then shows the Who's Online list. In other words, this function shows who are online inside and outside the forum.

Code

[Select] 
<?php ssi_logOnline();

Result

117 Guests, 0 Users

Login Function

Shows a login box only when user is not logged in.

Code

[Select] 
<?php ssi_login();

Result

Logout Function

Shows a logout link only when user is logged in.

Code

[Select] 
<?php ssi_logout();

Result

Welcome Function

Greets users or guests, also shows user's messages if logged in.

Code

[Select] 
<?php ssi_welcome();

Result

Welcome to ElkArte Community. Please login or register.

Today's Calendar Function

Code

[Select] 
<?php ssi_todaysCalendar();

Result

Today's Birthdays Function

Code

[Select] 
<?php ssi_todaysBirthdays();

Result

Today's Holidays Function

Code

[Select] 
<?php ssi_todaysHolidays();

Result

Today's Events Function

Code

[Select] 
<?php ssi_todaysEvents();

Result

Recent Calendar Events Function

Code

[Select] 
<?php ssi_recentEvents();

Result

Forum Stats

Shows some basic forum stats: total members, posts, topics, boards, etc.

Code

[Select] 
<?php ssi_boardStats();

Result

Total Members: 1,011
Total Posts: 43,557
Total Topics: 4,430
Total Categories: 5
Total Boards: 32

News Function

Shows random forum news.

Code

[Select] 
<?php ssi_news();

Result

Want to get involved in developing ElkArte?  We are an open source project and community that encourages others to help! Join us at our space on GitHub

Board News Function

Shows the latest posts from read only boards, or a specific board.

Code

[Select] 
<?php ssi_boardNews();

Result

December 31, 1969, 07:00:00 pm by
comments | Write Comment

December 31, 1969, 07:00:00 pm by
comments | Write Comment

December 31, 1969, 07:00:00 pm by
comments | Write Comment

December 31, 1969, 07:00:00 pm by
comments | Write Comment

December 31, 1969, 07:00:00 pm by
comments | Write Comment

Menubar Function

Displays a menu bar, like one displayed at the top of the forum.

Code

[Select] 
<?php ssi_menubar();

Result

Quick Search Function

Code

[Select] 
<?php ssi_quickSearch();

Result

Recent Attachments Function

Code

[Select] 
<?php ssi_recentAttachments();

Result

File Posted by Downloads File size
Attachement: bots.php Spuds 11 4.04 KB
Attachement: ElkArte_v1-1-10_install.zip Spuds 150 4.44 MB
Attachement: ElkArte_1110_patch.zip Spuds 96 142.55 KB
Attachement: SimpleAuditoVideoEmbeder.zip vbgamer45 109 54.25 KB
Attachement: Merry_Christmas.jpg Burke Knight 513 893.48 KB
Attachement: textscreen.jpg Steeley 1212 64.94 KB
Attachement: Email.png Burke Knight 1379 295.03 KB
Attachement: fate.jpg Steeley 1406 32.66 KB
Attachement: Screenshot_2.png radu81 3185 10.98 KB
Attachement: emer.jpg Steeley 3373 21.44 KB

Show Single Poll

Shows a poll in the specified topic.

Code

[Select] 
<?php ssi_showPoll($topicID);

Result

Not shown because it needs specific topic ID that contains a poll.

Show Single Post

Fetches a post with a particular IDs. By default will only show if you have permission to the see the board in question. This can be overriden by passing the 2nd parameter as true.

Code

[Select] 
<?php ssi_fetchPosts($postIDs, $isOverride);

Result

Not shown because it needs a specific post ID.

Show Single Member

Shows the specified member's name and profile link.

Code

[Select] 
<?php ssi_fetchMember($memberIDs);

Result

Not shown because it needs a specific member ID.

Show Group Members

Shows all members in a specified group.

Code

[Select] 
<?php ssi_fetchGroupMembers($groupIDs);

Result

Not shown because it needs specific membergroup IDs.

Home Page Sample

This sample uses the following features: ssi_recentTopics(), ssi_logOnline(), ssi_welcome(), and ssi_boardNews(). ssi_recentTopics() is fetched using the array method, to allow further customizations on the output.

Code

[Select] 
<?php require("SSI.php"); ?>
<!DOCTYPE html>
<html>
<head>
	<title>SSI.php example for home page</title>
	<style>
		html {
			width: 99%;
		}
		body {
			font: 87.5%/150% "Segoe UI", -apple-system, BlinkMacSystemFont, "Roboto", "Oxygen", "Ubuntu", "Cantarell", "Droid Sans", "Helvetica Neue", "Trebuchet MS", Arial, sans-serif;
			background: #DFDFDF;
			color: #FFFFFF;
			margin: 0;
		}
		ul, ol {
			padding-left: 1.25em;
			margin: 0;
		}
		li {
			font-size: 1em;
		}
		h1, h2, h3 {
			margin: 0;
			padding: 0;
		}
		h3 {
			font-size: 1em;
		}
		a:link,a:visited {
			color: #FF9000;
			text-decoration: none;
		}
		a:hover {
			text-decoration: underline;
		}
		#container {
			background: #52514E;
			width: 100%;
			border: 1px solid midnightblue;
			line-height: 150%;
			margin: 0;
		}
		#header, #footer {
			color: lightgray;
			background: #2A2825;
			clear: both;
			padding: .5em;
		}
		#leftbar {
			background: #DF7E00;
			float: left;
			width: 160px;
			margin: 0;
			padding: 1em;
		}
		#leftbar a {
			color: #000;
			text-decoration: underline;
		}
		#content {
			margin-left: 190px;
			padding: 1em;
		}
		#navigation {
			float: right;
		}
		#navigation a:link, #navigation a:visited {
			color: #FF9000;
		}
	</style>
</head>
<body>
<div id="container">
	<div id="header">
		<div id="navigation">
			<a href="#">Link</a> | <a href="#">Link</a> | <a href="#">Link</a> | <a href="#">Link</a> | <a href="#">Link</a>
		</div>
		<h1 class="header">YourWebsite.com</h1>
	</div>
	<div id="leftbar">
		<h3>Recent Forum Topics</h3>
		<ul>
<?php
// Using array method to show shorter display style.
$topics = ssi_recentTopics(8, null, null, 'array');

foreach ($topics as $topic)
{
	// Uncomment the following code to get a listing of array elements that the system provides for this function.
	// echo '<pre>', print_r($topic), '</pre>';

	echo '
			<li>
				<a href=\"', $topic['href'], '\">', $topic['subject'], '</a> ', $txt['by'], ' ', $topics[$i]['poster']['link'], '</li>';
}

unset($topics);
?>
		</ul><br />
		<h3>Online Users</h3>
		<?php ssi_logOnline(); ?>
	</div>
	<div id="content">
		<?php
		ssi_welcome(); ?><br /><br />
		<h2>News</h2>
		<?php ssi_boardNews(); ?>
	</div>
	<div id="footer">
		<a target="_blank" rel="license" href="http://creativecommons.org/licenses/publicdomain/"><img alt="Creative Commons License" style="border:0;" src="http://i.creativecommons.org/l/publicdomain/88x31.png" /></a>
		This sample website layout is dedicated to the <a target="_blank" rel="license" href="http://creativecommons.org/licenses/publicdomain/">Public Domain</a>.
	</div>
</div>
</body>
</html>

Result