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

[Site Feedback] EARLY Beta version of 2.0 by ahrasis April 24, 2024, 06:22:14 am
[Theme development] New Variants by Spuds April 23, 2024, 09:29:42 pm
[Feature Discussion] Notification Enhancements by Spuds April 13, 2024, 11:06:26 am
[Feature Discussion] Link rel="" values by Spuds April 05, 2024, 02:19:55 pm
[Chit Chat] Google Analytics by Spuds April 04, 2024, 09:22:12 am
[Exterminated Bugs] Elkarte 2.0 - Search inside a board displays results from other boards by Spuds April 02, 2024, 05:12:24 pm
[Exterminated Bugs] Elkarte 2.0 - full image inline inserted as thumbnail by Spuds April 02, 2024, 05:11:24 pm
[Feature Discussion] Post Preview Improvements by radu81 April 02, 2024, 06:23:40 am

Recent Posts Function

Code

[Select] 
<?php ssi_recentPosts();

Result

[Site Feedback] Re: EARLY Beta version of 2.0 by ahrasis April 24, 2024, 06:22:14 am
[Theme development] New Variants by Spuds April 23, 2024, 09:29:42 pm
[Site Feedback] Re: EARLY Beta version of 2.0 by Spuds April 23, 2024, 09:23:30 pm
[Site Feedback] Re: EARLY Beta version of 2.0 by Spuds April 23, 2024, 09:20:38 pm
[Feature Discussion] Notification Enhancements by Spuds April 13, 2024, 11:06:26 am
[Site Feedback] Re: EARLY Beta version of 2.0 by Spuds April 13, 2024, 09:20:32 am
[Feature Discussion] Re: Link rel=\ by Spuds April 05, 2024, 02:19:55 pm
[Feature Discussion] Re: Link rel=\ by Spuds April 04, 2024, 09:07:09 pm

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,151
New Support 745 5,927
New Feature Discussion 619 5,232
New General ElkArte discussions 336 3,866
New Addons 168 3,805
New Chit Chat 380 3,561
New Theme development 237 2,096
New Exterminated Features 187 1,962
New Site Feedback 134 1,671
New Bug Reports 189 1,647

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
Quote to an existing topic [was: Re: Quote to new topic] 452,180 4
Quote to new topic 415,266 14
[ADDON] SimplePortal 159,790 642
[ADDON][beta] Topic Prefix 112,404 99
IRC 111,576 380
Hello! 72,117 152
[ADDON] Social Login and Register 64,865 50
OpenImporter 61,184 212
New menu arrangement: Community - Staff - Personal 50,983 163
ElkArte 1.1.6 - Release announcement 45,850 28

Code (show by number of replies)

[Select] 
<?php ssi_topTopicsReplies();

Result

Views Replies
[ADDON] SimplePortal 159790 642
IRC 111576 380
OpenImporter 61184 212
BBC Parsing 40385 185
New menu arrangement: Community - Staff - Personal 50983 163
Hello! 72117 152
[ADDON] Levertine Gallery 25655 149
Stress relief 33885 133
Convert SMF to ElkArte 42287 125
ElkArte 1.1.7 Patch Testing 30195 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 olamitide, 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

ey
ey

Who's Online Function

This function shows who are online inside the forum.

Code

[Select] 
<?php ssi_whosOnline();

Result

498 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

498 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: 970
Total Posts: 43,283
Total Topics: 4,390
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

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