Box_comments is a module that retrieves a list of comments.
<vte:box module="box_comments">
<vte:params>
<vte:param name="search_limit" value="5" />
<vte:param name="search_sort_by" value="created" />
<vte:param name="search_order" value="descending" />
<vte:param name="cache" value="1" />
</vte:params>
<vte:template>
<vte:if test="{comment_list}">
<ul>
<vte:foreach item = "comment" from = "{comment_list}">
<li>
<a href="{comment.get_article_href}"><vte:value select="{comment.get_summary}" /></a>
</li>
</vte:foreach>
</ul>
</vte:if>
</vte:template>
</vte:box>
| Parameter name | Value | Description |
|---|---|---|
| search_limit | integer | max number of comments to retrieve |
| pg | integer | 0 - default |
| search_order | 'ascending' | 'descending' | applies to search_sort_by |
| offset | integer | query offset, 0 based |
| fields | string | comma separated database fields |
| search_options | array | compact form of search parameters |
| search_article_id | integer | Search comments for article |
| search_user_id | integer | Search comments by user |
| search_status | 0 | 1 | 0: unapproved 1: approved |
| search_ip | integer | IP addres search filter (*,? wildcard allowed) |
| search_email | string | Poster e-mail filter (*,? wildcard allowed) |
| search_author | string | whole author name or a part of it |
| search_description | string | text search in description |
| search_search_date | integer | number of days |
| search_before_after | 0 | 1 | 0: before 1: after applies to search_search_date |
| search_sort_by | 'id' 'article_id' 'description' 'create_dt' 'author' 'email' 'ip' 'status' | sort result by criteria |
Assignments:
| Parameter name | Value | Description |
|---|---|---|
| comment_list_object | object | CommentsList object |
| comment_list | array | each item is an Comments object |
| article_id | integer | if searched for specific article comments |