Navigation

Search

ssi_topTopics

Description

Gets a list of the top topics by either replies or views. Used by ssi_topTopicsReplies and ssi_topTopicsViews...

Syntax

array ssi_topTopics ([string $type[, int $num_topics[, string $output_method]]])



Parameter $type

Expected type: Enumerated String
Description: The sorting type

Possible string values
Allowed values Description
'replies' Gets the top topics according to how many replies they have (default value)
'views' Gets the top topics according to how many times they've been viewed



Parameter $num_topics

Expected type: Integer
Description: How many topics to get (defaults to 10)



Parameter $output_method

Expected type: String
Description: Standard SSI.php output_method variable. Function displays pre-formatted results if this is 'echo', otherwise the array is returned. An array is also returned if no topics are found. Default (like usual) is echo.



Return value

Expected type: Array
Description: If output_method is 'echo', this function will simply display a pre-formatted version of the results. Otherwise returns an array of arrays, each representing a separate topic and containing the following keys

Array Elements
Key Optional Expected type Description
href no String The URL to the topic
id no Integer The topic ID
link no String The link to the topic
num_replies no Integer How many replies this topic has
num_views no Integer How many times this topic has been viewed
subject no String The subject of the topic


View all versions of this function