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

[Pre-Sale Questions] Autoembeder Questions by NIBOGO November 25, 2022, 12:43:29 AM
[Pre-Sale Questions] Two Factor Authentication Question by NIBOGO November 25, 2022, 12:42:51 AM
[Pre-Sale Questions] Social Login Question by NIBOGO November 25, 2022, 12:42:34 AM
[Pre-Sale Questions] Advanced Topic Prefix compatible with SMF 2.1.2 by NIBOGO November 22, 2022, 09:33:25 AM
[Main News] 35% OFF IN ALL PRODUCTS! BLACK FRIDAY PROMO by NIBOGO November 22, 2022, 08:35:01 AM
[Feedbacks] Change logs by coddyn July 30, 2022, 01:49:34 PM
[Pre-Sale Questions] Menu Editor by BellGabDotCom July 22, 2022, 01:12:06 PM
[Pre-Sale Questions] Urls / Actions for Likes Given / Received by NIBOGO July 18, 2022, 12:19:36 PM

Recent Posts Function

Code

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

Result

[Pre-Sale Questions] Re: Autoembeder Questions by NIBOGO November 25, 2022, 12:43:29 AM
[Pre-Sale Questions] Re: Two Factor Authentication Question by NIBOGO November 25, 2022, 12:42:51 AM
[Pre-Sale Questions] Re: Social Login Question by NIBOGO November 25, 2022, 12:42:34 AM
[Pre-Sale Questions] Re: Autoembeder Questions by littlenicki November 23, 2022, 03:43:01 AM
[Pre-Sale Questions] Social Login Question by littlenicki November 23, 2022, 03:41:17 AM
[Pre-Sale Questions] Two Factor Authentication Question by littlenicki November 23, 2022, 03:31:47 AM
[Pre-Sale Questions] Autoembeder Questions by littlenicki November 23, 2022, 03:13:18 AM
[Pre-Sale Questions] Re: Advanced Topic Prefix compatible with SMF 2.1.2 by NIBOGO November 22, 2022, 09:33:25 AM

Recent Poll Function

Code

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

Result

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

Latest Member Function

Shows the latest member's name and profile link.

Code

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

Result

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

Who's Online Function

This function shows who are online inside the forum.

Code

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

Result

22 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

22 Guests, 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.
Did you miss your activation email?

Today's Calendar Function

Code

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

Result

Upcoming Birthdays: Phobos (35), EtnoEred (47)

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

Total Members: 3683
Total Posts: 22861
Total Topics: 4156
Total Categories: 31
Total Boards: 165

News Function

Shows random forum news.

Code

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

Result

Join our Theme Club and discover how you can get a nicer forum!

Board News Function

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

Code

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

Result

xx 35% OFF IN ALL PRODUCTS! BLACK FRIDAY PROMO

November 22, 2022, 08:35:01 AM by NIBOGO
Looking for a way to make your SMF forum system even better? Look no further than our black Friday sale on all our products and themes with 35% off! From improved SEO capabilities to amazing social login, we have everything you need to make your forum the best it can be. So don't wait, use the coupon BLACKOFF and apply the discount starting now and until November 29!

You can still pay with any method you want: Credit Card, Bitcoins, or PayPal!
0 comments | Write Comment

xx 10% DISCOUNT FOR SMF 2.1 COMPATIBLE MODS

March 08, 2022, 12:10:11 AM by NIBOGO
Hello everyone!

Today we have uploaded all the mods that have been upgraded to support SMF 2.1, the final list of mods that are ready to download by our customers is the following:


At the moment there are no plans to upgrade all the other mods or themes to SMF 2.1 Final. If you are planning to upgrade to SMF 2.1 this is a perfect time as all your favorite mods are compatible now and we are also offering a 10% OFF discount for all products using the coupon UPGRADE which is available until March 20.
6 comments | Write Comment

xx BLACK FRIDAY 2021!

November 26, 2021, 09:27:05 AM by NIBOGO
SMFPacks.com is celebrating Black Friday and Cyber Monday starting TODAY! From now and until December 1 there will be an unbeatable discount on every Pack, Mod, and Theme (renewals included!). All products will have an amazing 35% OFF! To use this coupon, simply into the discount page add the coupon: "BLACK35"!

You can still pay with any method you want: Credit Card, Bitcoins, or PayPal!

Do not hesitate and take advantage of this promotion as this will be the last one of this year :D title=Cheesy
0 comments | Write Comment

xx HAPPY NEW YEAR!

December 31, 2020, 10:52:17 AM by NIBOGO

With 2020 coming to a close, we wanted to reach out and send our best wishes to you and yours! I hope that 2021 holds success and good fortune in any endeavor you pursue. It has been a pleasure getting to know you and your community this year.

Thank you for supporting SMFPacks.com during this challenging year, see you in 2021!

3 comments | Write Comment

xx BLACK FRIDAY AT SMFPACKS.COM! GET ALL OUR PRODUCTS WITH 35% OFF!

November 27, 2020, 02:54:16 PM by NIBOGO
SMFPacks.com is celebrating Black Friday and Cyber Monday starting TODAY! From now and until December 5 there will be an unbeatable discount on every Pack, Mod, and Theme (renewals included!). All products will have an amazing 35% OFF! To use this coupon, simply into the discount page add the coupon: "BLACK35"!

You can still pay with any method you want: Credit Card, Bitcoins, or PayPal!

Do not hesitate and take advantage of this promotion as this will be the last one of this year :D

3 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

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