SMF SSI.php Functions

Current Version: 2.1.3

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.

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

[Internet Discussion] Get Pass Plus For Life by Skhilled Nov 21, 2024, 07:05 PM
[Internet Discussion] Digital Rights Bytes by Skhilled Nov 19, 2024, 08:30 PM
[Internet Discussion] THE DAILY SCAM NEWSLETTER | NOVEMBER 13, 2024 by Skhilled Nov 13, 2024, 08:42 PM
[Internet Discussion] THE DAILY SCAM NEWSLETTER | OCTOBER 23, 2024 by Skhilled Oct 30, 2024, 07:35 PM
[Internet Discussion] THE DAILY SCAM NEWSLETTER | OCTOBER 30, 2024 by Skhilled Oct 30, 2024, 06:26 PM
[Internet Discussion] Protect Yourself from Cops Using Biometrics to Search Your Phone! by Skhilled Oct 27, 2024, 07:08 PM
[Internet Discussion] How to Stop Cops From "Seeing Through Walls" to Spy on Your Home! by Skhilled Oct 27, 2024, 06:37 PM
[Internet Discussion] FedEx Trucks Will Be Spying On You For the Police by Skhilled Oct 27, 2024, 06:36 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
SMF 2.1 New 139 1,587
Theme Support New 97 1,248
Internet Discussion New 160 696
SMF 2.0.x New 48 537
Desktops & Laptops New 37 481
Servers, Hosts & Hosting New 46 279
Coding & Mods New 27 252
General Support New 27 227
Updates New 8 173
Showcase New 13 154

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
Smf 2.1 Tarz Theme 66,145 50
Time required for forum upgrade process? 56,766 43
2.1 Milestones 50,627 73
Brand new build 45,178 40
Theme for GSX1400Owners.ORG for SMF 2.1 37,569 69
Slide Tab Mod 36,222 55
SMF 2.1 RC2 32,460 24
Christmas theme 2.1RC3 31,752 52
Couple of strange errors 29,409 16
Github - progress on SMF 2.1 RC3? 26,670 92

Code (show by number of replies)

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

Result

Views Replies
Github - progress on SMF 2.1 RC3? 26,670 92
Cleantek Preview 26,134 92
2.1 Milestones 50,627 73
Theme for GSX1400Owners.ORG for SMF 2.1 37,569 69
AHem, lesmond, wanna play again? 22,573 65
[Theme] Drone edits 17,234 60
windows 10 1903 release date 12,425 58
PHP 7.3 Upgrade 17,305 58
Slide Tab Mod 36,222 55
Christmas theme 2.1RC3 31,752 52

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

Bigguy

Latest Member Function

Shows the latest member's name and profile link.

Code

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

Result

Please welcome Rebel, 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

Hatshepsut
I'm new here

Who's Online Function

This function shows who are online inside the forum.

Code

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

Result

23 Guests, 0 Users (1 Spider)
Bing

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

24 Guests, 0 Users (1 Spider)
Bing

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 to SMF Helper. Please log in or sign up.

Today's Calendar Function

Code

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

Result

Today's Birthdays Function

Code

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

Result

Today's Holidays Function

Code

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

Result

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

News Function

Shows random forum news.

Code

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

Result

Stable SMF release ver: 2.1.4

Board News Function

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

Code

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

Result

solved Happy New Year.

Dec 31, 2023, 04:50 PM by Bigguy
I just wanted to wish everyone a great New year. I hope we all can move past what happened last year and make this new one the best yet. Please, everyone have a safe night, but a good one. Don't do anything I wouldn't. ;) :pbeer :chrs
4 comments

solved Merry Christmas

Dec 23, 2023, 02:50 PM by Bigguy
I just wanted to say to all of the members here at SMFH and anyone else reading this...Please have a very Merry Christmas and a safe and happy New Year. May the New Year treat you good and have nothing but great things in store for you. :rgton
2 comments | Write Comment

announce Downtime

Oct 30, 2023, 11:59 AM by Bigguy
Sorry for that bit of downtime. All is good now. The site is good for another year. :rgton :vcool
5 comments | Write Comment

announce Site Move

Mar 04, 2023, 09:13 AM by Bigguy
This site will be moving from it's location in Australia to one in Canada. Nesa has been made a temp Admin so he can preform this operation. If the site is down for you at some point, this could be the reason. Please stay tuned for further updates, thank you. :rgton Also, the site will be getting and upgrade from GH soon. 
20 comments

announce Update 2023

Jan 04, 2023, 05:22 PM by Bigguy
So I am gonna do an upgrade from GH soon. I am going to save the default theme as it is before I do the upgrade just so I can put a few things from it back into the next theme. I have been watching GH and think it's a good time to get one done. This should be happening within the next 5 to 7 days depending on time. if you start to see mods missing and stuff, well, it's just me gettin ready for it. :vcool
16 comments

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

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 overridden 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> <html> <head> <title>SSI.php example for home page</title> <style> 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="noopener" rel="license" href="https://creativecommons.org/licenses/publicdomain/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/publicdomain/88x31.png"></a> This sample website layout is dedicated to the <a target="_blank" rel="noopener" rel="license" href="https://creativecommons.org/licenses/publicdomain/">Public Domain</a>. </div> </div> </body> </html>

Result