Discussions API
- Display mode: boards
- Display mode: categories
- Display mode: comments
- Display mode: deletecomment
- Display mode: discussions
- Display mode: editcomment
- Display mode: newcomment
- Display mode: newdiscussion
Display mode: boards
Show
before_show
| Tag | Description |
|---|---|
| __rssfeedurl__ | URL to the RSS feed of the site (all boards). |
show
| Tag | Description |
|---|---|
| __alt__ | Returns the string "alt" for odd-numbered rows (1, 3, etc.) for use in styling. |
| __description__ | Textual description of the discussion board as entered in the backend. |
| __name__ | Name of the discussion board as entered in the backend. |
| __rssfeedurl__ | URL to the RSS feed of the board. |
| __slug__ | Slugged version of the discussion board name. |
| __url__ | URL to view the categories within the board. |
| Any Custom Fields setup for Discussions will output their API tags | |
Display mode: categories
Parameters
boardname
Specifies the board to return the categories for.
Example:
"boardname:slugged-board-name",
Show
nav
| Tag | Description |
|---|---|
| __boardname__ | Name of the discussion board that the discussion belongs to. |
| __boardurl__ | URL of the discussion board. |
before_show
| Tag | Description |
|---|---|
| __rssfeedurl__ | URL to the RSS feed of the board. |
| Any Custom Fields setup for Discussions will output their API tags | |
show
| Tag | Description |
|---|---|
| __alt__ | Returns the string "alt" for odd-numbered rows (1, 3, etc.) for use in styling. |
| __boardslug__ | Slugged version of the discussion board name. |
| __count__ | Total number of discussions within the category. |
| __description__ | Textual description of the category as entered in the backend. |
| __name__ | Name of the category as entered in the backend. |
| __position__ | Numerical position of the category in relation to the rest of the categories. The ordering of categories is arranged in the backend. |
| __rssfeedurl__ | URL to the RSS feed of the category. |
| __slug__ | Slugged version of the category name. |
| __url__ | URL to view the discussions within the category. |
Display mode: comments
Parameters
boardname
Specifies the board where the comments reside.
Example:
"boardname:slugged-board-name",
categoryname
Specifies the category where the comments reside.
Example:
"categoryname:slugged-category-name",
discussionid
Specifies the discussion ID of the comments.
Example:
"discussionid:5891",
page
Specifies which page of comments to return. The pages are computed based upon the number of records-per-page set in the backend configuration for the discussion board.
Example:
"page:2",
Show
nav
| Tag | Description |
|---|---|
| __boardname__ | Name of the discussion board that the discussion belongs to. |
| __boardurl__ | URL to view the categories within the board. |
| __categoryname__ | Name of the category that the discussion belongs to. |
| __categoryurl__ | URL to view the discussions within the category. |
| __discussionname__ | Name of the discussion that the comment belongs to. |
| __discussionurl__ | URL to view the comments within the discussion. |
before_show
| Tag | Description |
|---|---|
| __rssfeedurl__ | URL to the RSS feed of the discussion. |
show
| Tag | Description |
|---|---|
| __alt__ | Returns the string "alt" for odd-numbered rows (1, 3, etc.) for use in styling. |
| __anchor__ | Used when the system wants to direct the user to a specific comment, such as after a comment has been added or edited. In the form of 'comment-#', where '#' is replaced by the comment ID. |
| __comment__ | Comment text with new lines represented by the HTML br tag. |
| __datecreated__ | Creation date and time of the comment. Parameters format Specifies the date and time format following PHP's date() formatting conventions (i.e., 'F, j, Y'). |
| __editdate__ | Date and time of the last edit. Parameters format Specifies the date and time format following PHP's date() formatting conventions (i.e., 'F, j, Y'). |
| __editmemberid__ | Member ID of the last editor. |
| __editurl__ | URL to edit the comment. |
| __editusername__ | Username of the last editor. |
| __id__ | ID of the comment within the system. |
| __memberid__ | Member ID of the commentor. |
| __username__ | Username of the commentor. |
pagination
| Tag | Description |
|---|---|
| __currentpage__ | Current page number. |
| __firstpage__ | URL to the first page of discussions. |
| __lastpage__ | URL to the last page of discussions. |
| __nextpage__ | URL to the next page of discussions. |
| __previouspage__ | URL to the previous page of discussions. |
| __recordfrom__ | Starting record number of the current page. |
| __recordto__ | Ending record number of the current page. |
| __totalpages__ | Total number of pages as determined by the number of records specified per-page in the backend. |
| __totalrecords__ | Total number of discussions. |
Display mode: deletecomment
Parameters
commentid
Specifies which comment ID to delete.
Example:
"commentid:8891",
Show
show
| Tag | Description |
|---|---|
| __deleteurl__ | URL to delete the specified comment. |
| __formclose__ | Closing form tag. |
| __formopen__ | Opening form tag with the required action and method attributes. |
| __submitbutton__ | Submit button with the name and id attributes set to 'discSubmit'. Parameters value Specifies the text value of the submit button. If nothing is specified, 'Delete' is used for the default value. |
Display mode: discussions
Parameters
boardname
Specifies the board where the discussions reside.
Example:
"boardname:slugged-board-name",
categoryname
Specifies the category where the discussions reside.
Example:
"categoryname:slugged-category-name",
page
Specifies which page of discussions to return. The pages are computed based upon the number of records-per-page set in the backend configuration for the discussion board.
Example:
"page:2",
Show
nav
| Tag | Description |
|---|---|
| __boardname__ | Name of the discussion board that the discussion belongs to. |
| __boardurl__ | URL to view the categories within the board. |
| __categoryname__ | Name of the category that the discussion belongs to. |
| __categoryurl__ | URL to view the discussions within the category. |
before_show
| Tag | Description |
|---|---|
| __rssfeedurl__ | URL to the RSS feed of the category. |
show
| Tag | Description |
|---|---|
| __alt__ | Returns the string "alt" for odd-numbered rows (1, 3, etc.) for use in styling. |
| __boardslug__ | Slugged version of the board name. |
| __categoryslug__ | Slugged version of the category name. |
| __count__ | Total number of comments within the discussion. |
| __datecreated__ | Creation date and time of the discussion. Parameters format Specifies the date and time format following PHP's date() formatting conventions (i.e., 'F, j, Y'). |
| __datelastactive__ | Date and time of the last activity within the discussion, such as a new comment. Parameters format Specifies the date and time format following PHP's date() formatting conventions (i.e., 'F, j, Y'). |
| __id__ | ID of the discussion within the system. |
| __lastmemberid__ | Member ID of the last commentor. |
| __lastusername__ | Username of the last commentor. |
| __memberid__ | Member ID of the discussion starter. |
| __name__ | Name of the discussion. |
| __rssfeedurl__ | URL to the RSS feed of the discussion. |
| __slug__ | Slugged version of the discussion name. |
| __url__ | URL to view the comments within the discussion. |
| __username__ | Username of the discussion starter. |
pagination
| Tag | Description |
|---|---|
| __currentpage__ | Current page number. |
| __firstpage__ | URL to the first page of discussions. |
| __lastpage__ | URL to the last page of discussions. |
| __nextpage__ | URL to the next page of discussions. |
| __previouspage__ | URL to the previous page of discussions. |
| __recordfrom__ | Starting record number of the current page. |
| __recordto__ | Ending record number of the current page. |
| __totalpages__ | Total number of pages as determined by the number of records specified per-page in the backend. |
| __totalrecords__ | Total number of discussions. |
Display mode: editcomment
Parameters
commentid
Specifies which comment ID to edit.
Example:
"commentid:8891",
Show
show
| Tag | Description |
|---|---|
| __commentfield__ | Textarea form field with the name and id attributes set to 'discComment'. Parameters cols Specifies the 'cols' parameter of the textarea form field. If nothing is specified, '50' is used for the default value. rows Specifies the 'rows' parameter of the textarea form field. If nothing is specified, '8' is used for the default value. |
| __formclose__ | Closing form tag. |
| __formopen__ | Opening form tag with the required action and method attributes. |
| __namefield__ | Text input form field with the name and id attributes set to 'discName'. |
| __submitbutton__ | Submit button with the name and id attributes set to 'discSubmit'. Parameters value Specifies the text value of the submit button. If nothing is specified, 'Submit' is used for the default value. |
Display mode: newcomment
Parameters
discussionid
Specifies the discussion ID where the comment will reside.
Example:
"discussionid:5891",
Show
show
| Tag | Description |
|---|---|
| __commentfield__ | Textarea form field with the name and id attributes set to 'discComment'. Parameters cols Specifies the 'cols' parameter of the textarea form field. If nothing is specified, '50' is used for the default value. rows Specifies the 'rows' parameter of the textarea form field. If nothing is specified, '8' is used for the default value. |
| __formclose__ | Closing form tag. |
| __formopen__ | Opening form tag with the required action and method attributes. |
| __submitbutton__ | Submit button with the name and id attributes set to 'discSubmit'. Parameters value Specifies the text value of the submit button. If nothing is specified, 'Submit' is used for the default value. |
Display mode: newdiscussion
Parameters
boardname
Specifies the board where the discussion will reside.
Example:
"boardname:slugged-board-name",
categoryname
Specifies the category where the discussion will reside.
Example:
"categoryname:slugged-category-name",
Show
show
| Tag | Description |
|---|---|
| __commentfield__ | Textarea form field with the name and id attributes set to 'discComment'. Parameters cols Specifies the 'cols' parameter of the textarea form field. If nothing is specified, '50' is used for the default value. rows Specifies the 'rows' parameter of the textarea form field. If nothing is specified, '8' is used for the default value. |
| __formclose__ | Closing form tag. |
| __formopen__ | Opening form tag with the required action and method attributes. |
| __namefield__ | Text input form field with the name and id attributes set to 'discName'. |
| __submitbutton__ | Submit button with the name and id attributes set to 'discSubmit'. Parameters value Specifies the text value of the submit button. If nothing is specified, 'Submit' is used for the default value. |