Function Module_vforums->_vforum
Definitions
forum/pages/modules/vforums.php
- The UI to show a virtual forum.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: object
Parameters
Name | Type | Default | Set | Range | Description |
---|---|---|---|---|---|
$title | Tempcode | required parameter | N/A | N/A | The title to show for the v-forum |
$condition | mixed | required parameter | N/A | N/A | The condition (a fragment of an SQL query that gets embedded in the context of a topic selection query). May be string, or array of strings (separate queries to run and merge; done for performance reasons relating to DB indexing) |
$order | string | required parameter | N/A | N/A | The ordering of the results |
$separate_pins | boolean | True | N/A | N/A | Whether to show pinning in a separate section |
$extra_tpl_map | array | [] | N/A | N/A | Extra template parameters to pass through |
$initial_table | ?string | Null | N/A | N/A | The table to query (null: topic table) |
$extra_select | string | Blank (empty string) | N/A | N/A | Extra SQL for select clause |
Return
- The UI
- Type: Tempcode
- Set: N/A
- Range: N/A