Function Forum_driver_wbb22->show_forum_topics

Definitions

sources/forum/wbb22.php

  • Get an array of topics in the given forum. Each topic is an array with the following attributes:- id, the topic ID- title, the topic title- lastusername, the username of the last poster- lasttime, the timestamp of the last reply- closed, a Boolean for whether the topic is currently closed or not- firsttitle, the title of the first post- firstpost, the first post (only set if $show_first_posts was true)
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Return: array

Parameters

Name Type Default Set Range Description
$name mixed required parameter N/A N/A The forum name or forum ID or an array of forum IDs (in such an array the KEYS are forum IDs, and the values ignored)
$limit integer required parameter N/A N/A The limit
$start integer required parameter N/A N/A The start position
$max_rows integer required parameter N/A N/A The total rows (not a parameter: returns by reference)
$filter_topic_title SHORT_TEXT Blank (empty string) N/A N/A The topic title filter (blank: no filter)
$filter_topic_description SHORT_TEXT Blank (empty string) N/A N/A The topic description filter; may apply to the topic title if there is no separate description field with additional wildcarding to match what make_post_forum_topic is doing (blank: no filter)
$show_first_posts boolean False N/A N/A Whether to show the first posts
$date_key string lasttime N/A N/A The date key to sort by
$hot boolean False N/A N/A Whether to limit to hot topics
$only_open boolean False N/A N/A Open topics only

Return

  • The array of topics (null: error)
  • Type: ?array
  • Set: N/A
  • Range: N/A