Latest Register Log In

+ Advanced Search

Forum Variables

Forum Variables
By
09/24/03 (Edited 10/07/13)

{CATHASNEW} - If there's a new link in the forum, returns the image code for the updated image... otherwise, empty.
{CATHASNEWBOOL} - A true/false for use in conditionals to replace {CATHASNEW}.
{CATADMIN} - If viewer can edit forum, returns the edit topic for it... otherwise, empty.
{CATNUMSUBCATS} - The number of subforums in the forum
{CATNUMSUBCATSALL} - The number of subforums including personal link lists if applicable.
{CATNUMLINKS} - Number of links in the forum plus all its subforums.
{CATLINKSHERE} - Number of links in the forum excluding subforums.
{CATSUBCATS} - HTML for displaying the subforums of the forum.
-- Optional parameters: html to use for each forum, maximum number to show. limits list to 5.
{CATPARENTNAME} - The name of this forum's parent forum.
{CATALIASEDIN} - A list of secondary locations of the forum.
{CATORIGCATNAME} - The name of the primary forum of an alias, otherwise just the forum name.
{CATORIGCATURL} - The url of the primary forum of an alias, otherwise just the forum url.
{CATNUMBERRELATED} - The number of forums related to this forum.
{CATDATE} - Date on which the forum was added.
{CATLASTEDITDATE} - Date on which the forum was last edited.
{CATLASTLINKDATE} - The date of the last link addition in the forum.
{CATLASTLINKTIME} - The time (as number of seconds since 1970) of the last link addition in the forum.
{CATNAMEWITHNAV} - The full path and forum (excludes the top level index link).
{CATNAV} - Navigation path to the forum (link to parents)
-- Optional parameters: nospace (removes spaces), bookmarkable (removes html) and trimset (trims off the nav separator character).
{CATTITLENAV} - The navigation, but without HTML, suitable for use in the language item title_forums.
-- Optional parameters: navseperator, trimseparator
{CATTYPEOPTIONS} - The options for selecting the forum type.
{CATLINKSELECTOR} - Options usable for maping a dropdown selector of all links in the forum -- quick jump to a link using a selector.
{CATID} - The id number of the forum.
{CATNAME} - Name of the forum.
{CATPARENT} - The id number of the forum's parent forum.
{CATDESCRIPTION} - Description of the forum.
-- Optional parameter: number of characters.
{CATDESCRIPTIONSTRIPPED} - The description with HTML removed.
{CATCUSTOM} - The custom template this forum uses if applicable.
{CATHEADERINFO} - This forum's header info (meta tags, etc)
{CATTYPE} - The forum type of this forum.
{CATTOTALCOMMENTS} - The total number of posts for all links in the forum.
{CATISBENEATH[x]} - This will return a true or false depending on if the current forum is somewhere beneath the target forum x in your directory structure. x needs to be the id number of the forum you want to know if this is below. (This is useful for some conditionals.)
{CATLEVELSDEEP} - The number of levels deep the forum is, 0 being a main forum, 1 a subforum, etc.
{CATRANDOMLINK} - Returns link to a randomly selected link from the forum.
-- Optional paramater: template. Defaults to <a href="{TRACKLINKURL}">{LINKTITLE}</a>
{CATSTATICNAME} - The static file name (with path if applicable) that would be generated for this forum if you're using HTML generation.
{CATTYPETOTAL[typename]} - The total number of topics in the forum which are of the type typename. For example, 17 for regular topics.
{CATVIEWS} - The number of unique views of the forum.
{CATLASTTHREADID} - The id of the most recently posted to thread in the forum.
{CATLASTHREADTITLE} - The title of the most recently posted to thread in the forum.
{CATLASTPOSTERID} - The id of the last poster in the most recently posted to thread in the forum.
{CATLASTPOSTERNAME} - The name of the last poster in the most recently posted to thread in the forum.
{CATLASTCOMMENTDATE} - The date/time of the most recent posted in the forum.
{CATCHECKED[field <,> value]} - Test whether a checkbox field is checked for the specified value (if only one value, you can skip the value).
{CATTOPLEVELID} - The id of the top level ancestor of the forum (if the forum is at the top level, then its own id).
{CATTOPLEVELNAME} - The name of the top level ancestor of the forum (if the forum is at the top level, then its own id).
{CATNUMBER} - The position of the forum's appearance in the forum topics.
{CATSUMFIELD[fieldname]} - Gets the sum of values for the forum for any numeric field. You can pass a number of decimal places as a second parameter, the default is two.
{CATLASTAVATARURL} - The URL of the avatar of the last poster in a thread in the forum.
-- Optional parameters: maximum width and height of the avatar. Example: {CATLASTAVATARURL[30 <,> 15]}
{CATSUBSCRIBERLIST} - Lists the members subscribed to the forum.
-- Optional parameter: Format, which defaults to <a href="{MEMBERPROFILEURL}">{MEMBERNAME}</a>,
{CATFOLDERIMAGE} - The URL of the folder icon -- either the default ones or a custom uploaded one.
-- Optional parameters: width and height in pixels. Defaults to size of uploaded image. Use {CATFOLDERICON[100 <,> 150]} for 100x150.

{NUMBER} and {LETTER} can also be used with forums to display the order of their appearance. Using {NUMBER} they'll be numbered from 1 on up, using {LETTER} they'll be labeled from a to z.

To show the total of each type within a forum while on the display topics page, use {REGULARTOTAL}, {OTHERTYPETOTAL} etc. Elsewhere use CATTYPETOTAL as explained above.

To show the moderators of a forum, use

<IF {CATHASMODERATORS}><!-- BEGIN MODERATORS --><a href="memberlist.php?action=profile&id={MEMBERID}" class="{MEMBERGROUPNAMESTYLE}">{MEMBERNAME}</a >,
<!-- END MODERATORS --></IF>


When you want your forum variable to be for the forum page being viewed, even when you're in a smaller forum scope (such as a toplist or similar forums), use {THISCAT instead of {CAT.




Description Summary of each forum template variable.
Rating
Views 6914 views. Averaging 1 view per day.