ssi_topBoards

Description

Shows a list of the top boards in descending order based on how many posts are in each board.

Syntax

array ssi_topBoards ([int $num_top[, string $output_method]])


Parameter $num_top

Expected type: Integer
Description: How many boards to find (defaults to 10)


Parameter $output_method

Expected type: String
Description: Standard SSI.php output_method variable. If 'echo' (default value), function returns pre-formatted HTML output. Otherwise the function returns an array.


Return value

Expected type: Array
Description: Either displays an HTML table with the info or returns an array of arrays with the info, depending on output_method

Array Elements
Key Optional Expected type Description
href no String The URL to the board
id no Integer The board ID
link no String The link to the board
name no String Board name
new no Boolean Whether or not this board has new posts in it
num_posts no Integer How many posts are in this board
num_topics no Integer How many topics are in this board


Notes

  • Uses the standard $output_method variable
  • In 1.1, the "Count child's posts in parents totals" option has no effect on this function.
View all versions of this function
Advertisement: