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
[Off Topic] | [BBc] Block Builders Club by oh shit waddup | June 16, 2019, 09:40:32 PM |
[Off Topic] | [BASE] Blockland Alliance of Space Exploration - Placeholder For Future Use by oh shit waddup | July 13, 2016, 09:48:39 PM |
[Script Workshop] | ►►►Tips On Creating Scripts by Royston Staley | June 10, 2016, 08:50:02 AM |
[Pitch Meeting] | Let's Start Brainstorming Projects by Bester Bageler | May 07, 2016, 11:16:12 PM |
[General Clan Discussion] | 8 Years of Block Wars! by Veetoo | May 05, 2016, 07:04:20 AM |
[Pitch Meeting] | Arabian Pirates - Pitch/Discussion by Bester Bageler | May 04, 2016, 06:22:29 PM |
[Projects We're Working On] | Block Wars: Episode IV - No Hope (COMPLETE) by Nicepoint | April 13, 2016, 09:10:56 AM |
[Resources] | How to Make Blockland Machinima PART 1! by oh shit waddup | February 13, 2016, 12:27:29 AM |
Recent Posts Function
Code
<?php ssi_recentPosts(); ?>
Result
[Off Topic] | [BBc] Block Builders Club by oh shit waddup | June 16, 2019, 09:40:32 PM |
[Off Topic] | [BASE] Blockland Alliance of Space Exploration - Placeholder For Future Use by oh shit waddup | July 13, 2016, 09:48:39 PM |
[Script Workshop] | Re: ►►►Tips On Creating Scripts by Royston Staley | June 10, 2016, 08:50:02 AM |
[Pitch Meeting] | Re: Let's Start Brainstorming Projects by Bester Bageler | May 07, 2016, 11:16:12 PM |
[Pitch Meeting] | Re: Let's Start Brainstorming Projects by Veetoo | May 06, 2016, 06:57:23 AM |
[General Clan Discussion] | Re: 8 Years of Block Wars! by Veetoo | May 05, 2016, 07:04:20 AM |
[Pitch Meeting] | Arabian Pirates - Pitch/Discussion by Bester Bageler | May 04, 2016, 06:22:29 PM |
[Pitch Meeting] | Re: Let's Start Brainstorming Projects by Jakob | April 24, 2016, 02:02:08 PM |
Top Boards Function
Shows top boards by the number of posts.
Code
<?php ssi_topBoards(); ?>
Result
Board | Topics | Posts |
---|---|---|
Projects We're Working On | 2 | 12 |
Off Topic | 7 | 12 |
General Clan Discussion | 3 | 8 |
Pitch Meeting | 3 | 8 |
Script Workshop | 2 | 5 |
Set Design | 1 | 3 |
Resources | 2 | 2 |
Cast and Crew | 1 | 1 |
Props and Wardrobe | 0 | 0 |
Top Topics
Shows top topics by the number of replies or views.
Code (show by number of views)
<?php ssi_topTopicsViews(); ?>
Result
Views | Replies | |
---|---|---|
Block Wars: Episode IV - No Hope (COMPLETE) | 1842 | 8 |
The Karma System | 1770 | 1 |
8 Years of Block Wars! | 1388 | 4 |
While that may have got us all hot and bothered | 1256 | 0 |
The spam keeps coming. | 1168 | 3 |
NHL all star game | 1165 | 1 |
While that may have got us all hot and bothered PART 2 | 1161 | 1 |
Let's Start Brainstorming Projects | 1044 | 4 |
Menen - Placeholder Post for BLF - Ignore | 993 | 0 |
Half-Life 2: Point Inderption | 901 | 2 |
Code (show by number of replies)
<?php ssi_topTopicsReplies(); ?>
Result
Views | Replies | |
---|---|---|
Block Wars: Episode IV - No Hope (COMPLETE) | 1842 | 8 |
8 Years of Block Wars! | 1388 | 4 |
Let's Start Brainstorming Projects | 1044 | 4 |
The spam keeps coming. | 1168 | 3 |
Half-Life 2: Point Inderption | 901 | 2 |
Shit set design tips that I think applys here. | 888 | 2 |
Brick Blockman: Attorney at Law | 770 | 2 |
►►►Tips On Creating Scripts | 874 | 1 |
►►► How to Pitch an Idea | 883 | 1 |
The Karma System | 1770 | 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
Veetoo
- V2/General Blockster [BL_ID: 9855] |
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
News Function
Shows random forum news.
Code
<?php ssi_news(); ?>
Result
Board News Function
Shows the latest posts from read only boards, or a specific board.
Code
<?php ssi_boardNews(); ?>
Result
8 Years of Block Wars!
Happy 8 year anniversary!
8 years ago today I started the first Block Wars topic that would eventually produce the short film version of the machinima parody we know it as today.
Wow. That's the weirdest feeling. Cause see, 8 years is a long time, but 2 years is not a long time at all, and in 2 years it'll officially have been a decade since I first decided to start making Blockland machinima.
I just thought I'd let you all know that basically if it hadn't been for that first machinima we wouldn't have BLC today. So hoorah!
The Karma System
Well, here on the BLCF, we'll be using it as a way to determine blacklisting members.
I couldn't for the life of me figure out how to create a system for guests vs registered members and I decided to just say fuck it and let anyone join the forums, cause why not. You don't have to be a member of the clan just to talk about Blockland videos.
So anyway, with that said and with the clan starting to gain more members that we might start using these forums more, I've decided to remind you all that the karma system is available.
If you think someone is a problem user who either has too many terrible ideas, terrible attitudes, or just is terrible in general, go ahead and give them a "fuck you." The amount of "fuck you" over "ya' done good" a person has will determine their quality as a member of these forums and if they continue to cause trouble without trying to rectify their situation (every person who gets to a certain low point of "fuck you" will be given one chance to try and redeem themselves) then they will be banned, or at least, dealt with accordingly.
Of course, try not to abuse the system. If you notice you're getting nothing but "fuck you" and know you're not breaking any rules or being a general dick (at least, you think so) then let me know and song long as you have proof you're being abused I'll clear your karma and ban anyone we find out is misusing their karma points (in fact, I'll add that as one of the rules of the forums as soon as I finish here).
And as for "ya' done good," those are also entirely optional and I'd suggest we save them for truly stellar moments of importance and not use them like "likes" on a Faceboob post.
So finally, I'm gonna sticky this topic but leave it open for discussion as I believe in creating an environment that encourages fair moderation, so if anyone ever has anything they don't like about the system or suggestions on better moderation or whathaveyou, here's the place to do that.
►►►Forum Rules
1. Do not post ambiguous topics - The title of your thread should describe its contents. If you are asking a question, there should be a question mark at the end. Ambiguous topics will be locked.
2. Do not post severely adult content - Softcore isn't exactly frowned upon if its in context, but use good judgement when posting content.
3. Use the Search feature before posting a question.
4. Think before you post - Completely unintelligible posts will be locked and moved to garbage.
5. Do not flame - If the entire point of your post is to tell someone what an idiot they are, don't bother.
6. Do not cross post. - Do not post the same thing in more than one forum.
7. No pyramid/referral schemes - No one is going to give you money or an iPod/flatscreeen monitor/xbox 360/whatever just for getting people to click on some crappy link. It's a scam to get you to spam forums for them. Stop posting this crap.
8. No chain-letter style spam - Copy and paste this message into 5 threads and you will be permanently banned.
9. Film ideas must be thought out - If you're going to suggest an idea for a movie, it must be in proper format else the topic will be locked and removed.
10. Do not abuse the karma system - Though this is generally harder to pinpoint, if you're caught downvoting someone for no good reason or orchestrating people to do this in order to get an innocent user banned, you yourself will be banned- no exceptions.
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>