SMF SSI.php Functions

Current Version: 2.1.6

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 Posts Function

Code

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

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
Trips and Events New 694 9,822
General Chatter New 178 1,824
Say Hello! New 129 1,261
Knowledge Bank New 171 1,007
Trip Reports New 115 850
For Sale / Wanted New 134 797
Videos New 224 665
News New 85 540
Non-Caving Chat/Info New 56 401
Mines New 61 398

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

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

2 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

3 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 to United Cavers Exploration Team. 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: 492
Total Posts: 47,398
Total Topics: 4,324
Total Categories: 5
Total Boards: 40

News Function

Shows random forum news.

Code

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

Result

UCET forum updated to SMF 2.1.6

Board News Function

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

Code

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

Result

xx UCET Trip Advisor - Thursday 10th July 2025

Jul 05, 2025, 07:59 PM by Owen
Hi all,

Thursdays club trip will be to Cambrian Slate Mine (Glyn Ceiriog).
A slate mine full of odd chambers and passages. In fact, it appears to be two mines connected via a "pit" (open working to surface).

Exit could be made through a drainage adit, from the workings to concrete pipe....it is wet, so be prepared to have some over welly dampness.

Inside there are many interesting things to see including small artefacts to huge, wall sized man-made features. There are also several flooded chambers with divers' lines attached.

A significant collapse has blocked part of the mine (perhaps the largest part).

Suitability: Suitable for novices & first timers.

Location: SJ 189 379 (Approx)

Directions: From the roundabout in the centre of the village "Glyn Ceiriog", take "Quarry Road" (it is signed and is also marked as a cul de sac).
Drive up for around a mile and you will see the road forks left and right with a rough layby on the left and the left fork is a private road. Park there.

Link to Parking: https://tinyurl.com/2n7phbcx  (Parking is very limited, car sharing is highly advised)

Nearest Postcode: LL20 7DF

Requirements: Helmet, headtorch, wellies, oversuit (outoor/hiking clothing will suffice), gloves & big torches if you have them.

Please let us know in good time if you need to borrow a lid and lamp.

Meet Date: Thursday 10th July 2025
Meet Time: 18:30-18:45

If you do wish to come, please let us know by replying on this forum. 

Looking forward to seeing you all there!

Thanks,
Oz! ;D
(Trip Guide)
1 comment | Write Comment

xx UCET Trip Advisor - Thursday 26th June 2025

Jun 22, 2025, 12:40 PM by Jacob Mitchell
UCET Trip Advisor Thursday 26th June

Hello all,

Here are the details for our next Thursday evening trip;

Belgrave mine

This week we will be headed to Belgrave mine near Maeshafn for a walkabout trip (not doing the SRT trip this time). This will probably involve a small amount of crawling and climbing. We will be exploring both the middle and top adits. There is plenty to see including miners graffiti

This trip is open to non-members, please let us know in advance if you need to borrow ang equipment


Location : Llanferes
Meet Place : Llanferes layby (parking for pothole quarry / bryn alyn)
Link to parking: https://maps.app.goo.gl/7fTMgAzE3jhFLNdj6
Meet Date : 26th June
Meet Time : 18:30pm - 18:45pm
Suitability : novice
Requirements : Helmet, Lamp etc

Here is a link to the forum thread; https://www.ucet.org.uk/index.php?topic=11854.new#new




Thanks
Jacob

3 comments | Write Comment

xx UCET Trip Advisor - 12th June 2025

Jun 10, 2025, 09:41 AM by Jacob Mitchell
UCET Trip Advisor 12th June 2025- Poachers Cave

Hello all,

Here are the details for our next Thursday trip:

This week we will be heading to Poachers Cave/ Ogof Hen Ffynhonnau in Cilcain. Thought to be over 500,00 years old, the cave is full of interesting passages and formations, including the 'big boss' chandelier chamber, a very rare iscosceles passage, and much more

The trip is ideal as an introduction to caving for anyone interested in giving it a go. You will get muddy and wet. Please let us know in advance if you need to borrow any equipment.


Location : Poachers cave (ogof hen ffynhonnau)
Meet Place : Cilcain bridge
Meet Date : 12/06/25
Meet Time : 18:30 - 18.45
Suitability : Novice. Perfect first caving trip for beginners.
Requirements : Wellies, overalls, helmet, lamp, gloves, optional belt or harness for short entrance lifeline. Any equipment can be borrowed from the club if needed.
Link to Parking; https://maps.app.goo.gl/R4cxXBT3x4vBDK2E6

Please let us know on the forum if you are planning on being there

Here is a link to the forum thread:


Thanks,
Jacob
2 comments | Write Comment

xx UCET Ladies Trip Advisor - Monday 16th June 2025

May 29, 2025, 10:47 AM by Mary Cutts
UCET Ladies Trip Advisor - Monday 16th June 2025

Ogof Nadolig


Hi Ladies
This month's trip we are heading to one of North Wales Caves - Ogof Nadolig.

Meet Place : Cilcain Bridge
Meet Date : Monday 16th June 2025
Meet Time : 6:30pm
Requirements : Wellies, overalls, helmet, lamp, gloves, Knee pads, harness/tails & down gear

Link to Parking at Cilcain Bridge: maps.app.goo.gl/BzhvGEUvyuuhyAaw8

After meeting here, it is best to car share to the next meet point.
(Limited to 4-5 cars MAX)

This cave is "squeezy" and muddy. Descent is by a 10 foot maypole ladder, there is a flat out crawl of around 30 feet and a rope assisted descent down a pot of, around 15 feet at 45 degrees then 10 feet vertical, which is descended using down gear.

Suitable for novices with some experience.

If you need to borrow a lid and lamp please let us know, down gear can be shared between us, so don't worry if you don't have anything.

Please confirm attendance here on the forum.

See you there, Mary  :D
2 comments | Write Comment

xx UCET Trip Advisor- Thursday 22nd May 2025

May 15, 2025, 06:06 PM by Jacob Mitchell
UCET Trip Advisor Thursday 22nd May

Hello all,

Here are the details for our next Thursday evening trip;

Hendre Spar mine
IMPORTANT - NO Social Media photos are to be shared from the land accessing the mine or of inside the mine. Please only circulate photos taken, in the PRIVATE areas of the forum and through Whatsapp community only

There are 3 options for this weeks trip:

1) SRT / rigging practice- I believe Charlie will be practicing rigging on two pitches near the entrance so there is the option to practice SRT / rigging skills

2) Help with some maintenance- Gaz is going to be making the entrance shaft more secure, and any volunteers who'd like to help are greatly appreciated

3) Walkabout- Mary will be leading a walkabout trip in the mine. Suitable as a first trip for anyone interested in giving it a go


Location : Hendre Spar mine
Meet Place : Hendre, near the Royal Oak- either in small carpark opposite or near the road
Link to Parking: maps.app.goo.gl/T4RRLnFFGQqBz7gH6
Meet Date : 22nd May
Meet Time : 18:30pm - 18:45pm
Suitability : Novice (walkabout), SRT competency (if doing SRT)
Requirements : Overalls, Helmet, Lamp, change of clothes, full SRT kit (optional)


Here is a link to the forum thread;
https://www.ucet.org.uk/index.php?topic=11832.0



Thanks
Jacob (Trip Organiser)
12 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 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