SMF SSI.php Functions
Current Version: 2.0
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:
<?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 the SSI FAQ.
Recent Topics Function
Code (simple mode)
<?php ssi_recentTopics(); ?>
Code (advanced mode)
<?php ssi_recentTopics($num_recent = 8, $exclude_boards = null, $include_boards = null, $output_method = 'echo'); ?>
Result
[1st of March 2020 - Back ONLINE!!!] | 11 YEARS by Flow | March 01, 2020, 11:48:37 PM |
[Happenings] | Wide Awake In Wonderland by Flow | August 03, 2017, 08:14:22 PM |
[Happenings] | Rooster Rave - 11 Feb 2017 by Flow | January 20, 2017, 07:43:05 PM |
[Happenings] | DAS BOOT - July 13th 2014 by Flow | January 20, 2017, 06:56:12 PM |
[Think´n´win] | HOOK by Flow | December 12, 2016, 11:21:14 AM |
[Happenings] | Jennys 40th birthday - MARAVILLOSO!! by Flow | July 14, 2016, 04:08:26 PM |
[Happenings] | Yoga, Roses and more by Flow | March 23, 2016, 09:30:56 AM |
[Happenings] | Take some TIME OFF road by Flow | September 15, 2015, 02:40:27 PM |
Recent Posts Function
Code
<?php ssi_recentPosts(); ?>
Result
[1st of March 2020 - Back ONLINE!!!] | 11 YEARS by Flow | March 01, 2020, 11:48:37 PM |
[Happenings] | Wide Awake In Wonderland by Flow | August 03, 2017, 08:14:22 PM |
[Happenings] | Rooster Rave - 11 Feb 2017 by Flow | January 20, 2017, 07:43:05 PM |
[Happenings] | Re: DAS BOOT - July 13th 2014 by Flow | January 20, 2017, 06:56:12 PM |
[Think´n´win] | HOOK by Flow | December 12, 2016, 11:21:14 AM |
[Happenings] | Jennys 40th birthday - MARAVILLOSO!! by Flow | July 14, 2016, 04:08:26 PM |
[Happenings] | Yoga, Roses and more by Flow | March 23, 2016, 09:30:56 AM |
[Happenings] | Take some TIME OFF road by Flow | September 15, 2015, 02:40:27 PM |
Top Boards Function
Shows top boards by the number of posts.
Code
<?php ssi_topBoards(); ?>
Result
Board | Topics | Posts |
---|---|---|
Radio GAGA ![]() |
60 | 60 |
Welcome! ![]() |
15 | 28 |
Links for open minds ![]() |
24 | 26 |
Happenings ![]() |
19 | 23 |
Sounds ![]() |
7 | 7 |
Tetris ![]() |
5 | 5 |
Bubbles ![]() |
4 | 4 |
Los Festivalitos ![]() |
3 | 3 |
Open Sources ![]() |
2 | 3 |
Art ![]() |
2 | 2 |
Top Topics
Shows top topics by the number of replies or views.
Code (show by number of views)
<?php ssi_topTopicsViews(); ?>
Result
Views | Replies | |
---|---|---|
Welcome to Project Off Road!! | 16954 | 0 |
Saying "hello" | 9845 | 7 |
virtual didgeridoo | 8826 | 0 |
pictures from the "FREE RADICALS" | 8025 | 0 |
DAS BOOT - July 13th 2014 | 7958 | 1 |
Beiträge vom 18.03.2012 - Trockenheit in Spanien und Finance Watch | 7744 | 0 |
Hello Everyone | 6825 | 1 |
happy birthday!! | 6339 | 2 |
Wide Awake In Wonderland | 6278 | 0 |
Ambient sounds self mixed | 6181 | 0 |
Code (show by number of replies)
<?php ssi_topTopicsReplies(); ?>
Result
Views | Replies | |
---|---|---|
Saying "hello" | 9845 | 7 |
SHARE THE LOVE | 5854 | 3 |
happy birthday!! | 6339 | 2 |
Open Sources - Festival 2011 - Part I | 4082 | 1 |
DAS BOOT - July 13th 2014 | 7958 | 1 |
Hello Everyone | 6825 | 1 |
Default Healthy alternatives to coffee?? | 3560 | 1 |
What do you do to avoid arguments? | 2887 | 1 |
What Hobbies Do You Have? | 3131 | 1 |
What is your favorite season of the year? | 2883 | 1 |
Top Poster Function
Shows the top poster's name and profile link.Code
<?php ssi_topPoster(); ?>
Result
Latest Member Function
Shows the latest member's name and profile link.
Code
<?php ssi_latestMember(); ?>
Result
Member of the Day
Shows one random member of the day. This changes once a day.
Code
<?php ssi_randomMember('day'); ?>
Result
Who's Online Function
This function shows who are online inside the forum.
Code
<?php ssi_whosOnline(); ?>
Result
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
<?php ssi_logOnline(); ?>
Result
Login Function
Shows a login box only when user is not logged in.
Code
<?php ssi_login(); ?>
Result
Logout Function
Shows a logout link only when user is logged in.
Code
<?php ssi_logout(); ?>
Result
Welcome Function
Greets users or guests, also shows user's messages if logged in.
Code
<?php ssi_welcome(); ?>
Result
Today's Calendar Function
Code
<?php ssi_todaysCalendar(); ?>
Result
Today's Birthdays Function
Code
<?php ssi_todaysBirthdays(); ?>
Result
Today's Holidays Function
Code
<?php ssi_todaysHolidays(); ?>
Result
Today's Events Function
Code
<?php ssi_todaysEvents(); ?>
Result
Forum Stats
Shows some basic forum stats: total members, posts, topics, boards, etc.
Code
<?php ssi_boardStats(); ?>
Result
Board News Function
Shows the latest posts from read only boards, or a specific board.
Code
<?php ssi_boardNews(); ?>
Result
Which do you prefer?
What is your favorite season of the year?
I like summer the most, this is not a surprise I think, this is the season where I can lay on the sand and just enjoy the beach. Wear the best summer dress and shoes! I just love this. The natures so with the sunrise and sunset are just too spectacular to watch.
What Hobbies Do You Have?
What do you do to avoid arguments?
I used to just take it and argue but now I just can't be bothered anymore. Neither of us will ever changed, and that's fine with me. Nowadays, whenever I get angry I will not say a word, I go out and take a walk, a long walk. I will keep walking until my anger fades.
How about you? What do you do to control yourself from being angry?
Recent Attachments Function
Code
<?php ssi_recentAttachments(); ?>
Result
File | Posted by | Downloads | Filesize |
---|---|---|---|
![]() |
Flow | 460 | 272.58kB |
![]() |
Flow | 665 | 40.17kB |
![]() |
Jingle | 589 | 113.93kB |
![]() |
Jingle | 402 | 108.09kB |
![]() |
Jingle | 382 | 282.2kB |
![]() |
Jingle | 363 | 198.27kB |
![]() |
Jingle | 367 | 224.92kB |
![]() |
Jingle | 386 | 237.64kB |
![]() |
Jingle | 404 | 290.99kB |
![]() |
Jingle | 380 | 286.98kB |
Show Single Poll
Shows a poll in the specified topic.
Code
<?php ssi_showPoll($topicID); ?>
Result
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
<?php ssi_fetchPosts($postIDs, $isOverride); ?>
Result
Show Single Member
Shows the specified member's name and profile link.
Code
<?php ssi_fetchMember($memberIDs); ?>
Result
Show Group Members
Shows all members in a specified group.
Code
<?php ssi_fetchGroupMembers($groupIDs); ?>
Result
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
<?php require("SSI.php"); ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>SSI.php example for home page</title>
<style type="text/css">
body { font-family: Arial, Tahoma, sans-serif; font-size: 80%; background: #DFDFDF; color: #FFFFFF; margin: 0 }
ul,ol { padding-left: 19px; margin: 0; }
li { font-size: 11px; }
h1,h2,h3 { margin: 0; padding: 0; }
h3 { font-size: 15px; }
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-color: #2A2825; clear: both; padding: .5em; }
#leftbar { background: #DF7E00; float: left; width: 160px; margin: 0; padding: 1em; }
#leftbar a { color: #000000; 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 SMF 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-width: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>