Weever, an ExpressionEngine add-on by Studio625

ExpressionEngine Development » Weever » Parameters

Parameters

Note that all of these parameters go inside the exp:comment:entries tag, not inside the exp:weever tag.

• base_path
• comment_id
• comments_per_page
• dynamic
• limit
• paginate
• show_split_roots
• sort
• split_threads
• style
• weever
• weever_cache

base_path=

base_path="/entries/comments"

Optional. The base path for building pagination links.

comment_id=

comment_id="{segment_3}"

Optional. If a comment ID is specified, ONLY that comment will be displayed. This is useful for building a comment reply page on which only the comment being replied to (the "parent comment") and the form are shown. Note that many of Weever's variables are not available when a comment ID is specified.

comments_per_page=

comments_per_page="10"

Optional. If set, determines how many comments are shown on each page.

dynamic=

dynamic="off"

Optional. If set to "off", values in the URL will not affect the module's output.

limit=

limit="999"

Recommended if not using the "WSQL Hack", otherwise not required. This parameter is actually used by the Comment Module, not Weever. However, because of how Weever works, it is strongly recommended that you set this parameter to at least limit="999". (Hopefully a future version of EE's Comment Module will include the appropriate extension hook so that we don't have to do it this way.)

paginate=

paginate="bottom"

Optional. Determines the position of pagination links. May be set to "top", "bottom", or "both". Defaults to "bottom".

show_split_roots=

show_split_roots="yes"

Optional. If set to "yes", the root comment of a thread will be displayed on subsequent pages if the thread is interrupted by a page break. The root comments do not count toward the value set by comments_per_page. The default behavior is to not show the roots of split threads. This setting has no effect if split_threads is set to "no".

sort=

sort="desc"

Optional. Comments may be sorted in ascending ("asc") or descending ("desc") date order. Default is "asc". Note that "desc" can be very confusing in a nested layout. (Try it in a complex thread and see what we mean.)

split_threads=

split_threads="yes"

Optional. If set to "no", threads will never be split by page breaks. Instead, the entire thread will be shown. The default behavior is to split threads.

style=

style="date"

Optional. Sets the default display style. Available options include:

• threaded - Standard threaded format. Default.
• thread - Shows in threaded style by default, unless a specific thread is specified in the URL. To specify a thread in the URL, use a URL like http://example.com/article/comments/T16/, where 16 is the ID number of the comment at the root of the thread.
• top - Shows the top ("root") level of comments only.
• date - Displays comments in standard date order.

weever=

weever="on"

Required/Optional. In most cases you will want to set this parameter to "on" so that Weever runs as expected. If you omit this parameter (or set it to anything other than "on") Weever will not run.

weever_cache=

weever_cache="off"

Optional. By default, Weever utilizes caching to increase performance. If this parameter is set to "off", Weever's caching will be turned off.