SMF SSI.php Functions

Current Version: 2.1.7

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

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
Chit Chat Camp New 6,966 195,175
Project Research and Build-Ups New 3,653 177,444
Parts For Sale New 12,509 102,904
Toyota Pickup/4Runner Tech 1979-95 New 7,833 82,175
Engine New 5,794 69,774
Rig Gallery New 1,044 65,092
General 4WD Discussion New 4,367 62,421
New Member Check-In! New 4,259 46,831
Trail Reports, Events, and Gatherings New 1,992 39,942
Parts Wanted New 8,277 38,876

Top Topics

Shows top topics by the number of replies or views.

Code (show by number of views)

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

Result

Code (show by number of replies)

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

Result

Views Replies
Word association 1,972,437 19,743
Get Better Glen Thread! (some skin shown) 1,297,026 5,577
YOU!!!!!! 733,289 4,642
* The MACHO TACO * 1,006,013 4,572
Disgrace to Off-Road Pics. 1,027,117 4,181
Making Of The Willy Mammoth 1,021,798 3,680
Random picture thread 816,538 3,537
Silly Jokes 674,348 3,175
Glen's budget rebuild 743,276 3,123
What Are You Listening To Right At This Moment 459,206 3,102

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 PJC848, 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

1,465 Guests, 1 User
Prismo

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,465 Guests, 1 User
Prismo

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 Marlin Crawler Forum. 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

Total Members: 25,140
Total Posts: 1,086,757
Total Topics: 75,554
Total Categories: 6
Total Boards: 138

News Function

Shows random forum news.

Code

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

Result

Board News Function

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

Code

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

Result

turtle Panamint Valley Days, Nov 9-11, 2012!

October 15, 2012, 10:44:09 AM by BigMike
Marlin and I plan to be on the Defense Mine run for this year's PVD!

Event info: http://www.cal4wheel.com/events/panamint-valley-days

We are looking forward to seeing and wheeling with many of our friends there! :driving: :thumbs: :turtle:

Here are many pics from a past event: http://board.marlincrawler.com/index.php?topic=16401.0









12 comments | Write Comment

xx Panamint Valley Days, A Cal-4-Wheel Event 11-12 to 14, 2010

October 05, 2010, 04:32:58 AM by Rocksurfer
Cal-4-Wheel will be holding its annual off road event Panamint Valley Day's in November. It is fun for all ages plan to attend and support keeping our trails open. They have a website with more info on the event go to the link below for more information. I try to go every year hope to be there again.

http://www.cal4wheel.com/index.php?option=com_content&view=article&id=63&Itemid=92
0 comments | Write Comment

xx Panamint Valley Days Nov. 9th - 11th 2007

October 19, 2007, 08:06:05 PM by Rocksurfer
Forgot about this place, here's a link to this years event.


http://board.marlincrawler.com/index.php?topic=38064.0
0 comments | Write Comment

xx PANAMINT VALLEY DAYS NOV. 10 - 12, 2006

October 31, 2006, 08:07:28 PM by Rocksurfer
It's that time of year between Halloween and Thanksgiving that we venture to Panamint Valley and the Panamint Valley Days put on by Cal4Wheel. This is an annual event for our club and this year will be no different. Unfortunatly for the 1st time in a long time I will not be there. 

:rivers: 

Hope you guys have fun.

For those of you that are going use this thread for getting together, The Spinnin' Fours will try to get their usual spot just east of the main camp. I've included a link to directions to Panamint.


http://www.spinninfours.com/forums/viewtopic.php?t=987


Here's a link to Cal4Wheels Panamint page.

http://cal4wheel.com/pvd/index.html


5 comments | Write Comment

xx CALIFORNIA ASSOCIATION OF FOUR WHEEL DRIVE CLUBS INC.

October 06, 2006, 11:51:47 AM by Rocksurfer



Join the association, it helps keep our trails open plus you may win a cool Jeep. Then you'll join some Jeep board and we won't have to hear your crap anymore.
:rofl:

Quote
WE ARE ... Dedicated ... Determined ... On the Move...
We're the California Association of 4 Wheel Drive Clubs, Inc. Since 1959, our non-profit organization has actively promoted the advancement of vehicle oriented outdoor recreation. Today, the Association represents over 8,000 members and 160 member clubs. We are the largest organization of this type in the State and represent owners of all makes and models of 4WD vehicles, as well as non-owners who support responsible vehicle oriented recreation.

Helping 4 Wheelers...
We maintain a full time office in Sacramento. Our staff and volunteers work closely with legislators and land use managers to provide input, influence, expertise, and manpower to keep lands open to 4WD vehicle access. Many successful battles have been waged and won to keep trails open all over the State. We keep our members informed about important issues and changing laws through our monthly newspaper (In Gear) 

Having fun...
Members enjoy Association-sponsored events all year round. These events cover every type of terrain in every corner of the State. Whether you are interested in extremely challenging "hard rock" trails for the experienced enthusiast, or milder runs for the new 4-wheeler, we have several events just for you. Member clubs also sponsor monthly runs open to all.

Making a difference...
Our members are active in conservation projects throughout the State. Projects, which are coordinated with local agencies, can range from tree planting to removing junk cars from remote areas, from closing off entrances of hazardous mine shafts to repairing trail damage. We have received national recognition for winning "Take Pride in California" awards, and "Volunteers For Public Lands National Awards." Many clubs also have Adopt-A-Trails they are responsible for.

http://cal4wheel.com/
1 comment | 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 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