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:

Code: [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 the SSI FAQ.

Recent Topics Function

Code (simple mode)

Code: [Select]
<?php ssi_recentTopics(); ?>

Code (advanced mode)

Code: [Select]
<?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

Code: [Select]
<?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

Recent Poll Function

Code

Code: [Select]
<?php ssi_recentPoll(); ?>

Result

Top Boards Function

Shows top boards by the number of posts.

Code

Code: [Select]
<?php ssi_topBoards(); ?>

Result

Board Topics Posts
Radio GAGA New 60 60
Welcome! New 15 28
Links for open minds New 24 26
Happenings New 19 23
Sounds New 7 7
Tetris New 5 5
Bubbles New 4 4
Los Festivalitos New 3 3
Open Sources New 2 3
Art New 2 2

Top Topics

Shows top topics by the number of replies or views.

Code (show by number of views)

Code: [Select]
<?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)

Code: [Select]
<?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 Poll Function

Shows the most-voted-in poll.

Code

Code: [Select]
<?php ssi_topPoll(); ?>

Result

Top Poster Function

Shows the top poster's name and profile link.

Code

Code: [Select]
<?php ssi_topPoster(); ?>

Result

Flow

Latest Member Function

Shows the latest member's name and profile link.

Code

Code: [Select]
<?php ssi_latestMember(); ?>

Result

Please welcome lifisnado, our newest member.

Member of the Day

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

Code

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

Result

Dr Silverspoon

Who's Online Function

This function shows who are online inside the forum.

Code

Code: [Select]
<?php ssi_whosOnline(); ?>

Result

3 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

Code: [Select]
<?php ssi_logOnline(); ?>

Result

1 Guest, 0 Users

Login Function

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

Code

Code: [Select]
<?php ssi_login(); ?>

Result

 
 

Logout Function

Shows a logout link only when user is logged in.

Code

Code: [Select]
<?php ssi_logout(); ?>

Result

Welcome Function

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

Code

Code: [Select]
<?php ssi_welcome(); ?>

Result

Welcome, Guest. Please login or register.

Today's Calendar Function

Code

Code: [Select]
<?php ssi_todaysCalendar(); ?>

Result

Independence Day

Today's Birthdays Function

Code

Code: [Select]
<?php ssi_todaysBirthdays(); ?>

Result

Today's Holidays Function

Code

Code: [Select]
<?php ssi_todaysHolidays(); ?>

Result

Independence Day

Today's Events Function

Code

Code: [Select]
<?php ssi_todaysEvents(); ?>

Result

Recent Calendar Events Function

Code

Code: [Select]
<?php ssi_recentEvents(); ?>

Result

Forum Stats

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

Code

Code: [Select]
<?php ssi_boardStats(); ?>

Result

Total Members: 179
Total Posts: 166
Total Topics: 146
Total Categories: 2
Total Boards: 15

News Function

Shows random forum news.

Code

Code: [Select]
<?php ssi_news(); ?>

Result

Si quieres cambiar al mundo, cámbiate a ti mismo. - Mahatma Gandhi

Board News Function

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

Code

Code: [Select]
<?php ssi_boardNews(); ?>

Result

xx Which do you prefer?

July 31, 2014, 11:49:52 AM by nickraw
Do you like to talk on the phone or do you like to text better?I prefer to text,I don't really like to talk on the phone very much.
1 comment | Write Comment

xx What is your favorite season of the year?

July 31, 2014, 11:46:52 AM by nickraw
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.
1 comment | Write Comment

xx What Hobbies Do You Have?

July 31, 2014, 11:44:27 AM by nickraw
I like to play hockey, rugby, and game. (Of course :p) I also enjoy "motor" sports such as snowmobiling, dirtbiking, and fourwheeling.
1 comment | Write Comment

xx What do you do to avoid arguments?

July 31, 2014, 11:42:55 AM by nickraw
I'm a very straight forward person but most people I care around me are way too sensitive and it is always a disaster whenever we have conflicts between each other if we don't control.

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?
1 comment | Write Comment

xx Do you hunt?

July 31, 2014, 11:39:52 AM by nickraw
I actually dont but live in an area where many do.
0 comments | Write Comment

Menubar Function

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

Code

Code: [Select]
<?php ssi_menubar(); ?>

Result

Quick Search Function

Code

Code: [Select]
<?php ssi_quickSearch(); ?>

Result

Recent Attachments Function

Code

Code: [Select]
<?php ssi_recentAttachments(); ?>

Result

File Posted by Downloads Filesize
Rose Valley NEW (3) copy resized_2.jpg Flow 460 272.58kB
kiss feel bite me.jpg Flow 665 40.17kB
Rastro Calle Juan Relinque 2.JPG Jingle 589 113.93kB
Katamaran.JPG Jingle 402 108.09kB
Weltkarte.JPG Jingle 382 282.2kB
Burg 2.JPG Jingle 363 198.27kB
Arena 1.JPG Jingle 367 224.92kB
Früchte am Baum.JPG Jingle 386 237.64kB
Siempre Verde rund um die Finca.JPG Jingle 404 290.99kB
Dicke Wände mit Hund.JPG Jingle 380 286.98kB

Show Single Poll

Shows a poll in the specified topic.

Code

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

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

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

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

Code: [Select]
<?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>

Result