Comment¶

dynamic=¶

dynamic="no"

The channel and comment display engines set some parameters dynamically, based on what is in the URL. There are times, however, where you do not want the parameters affected by what the URL contains. To override the dynamic nature of the comment tag, use dynamic=”no”.

This is often useful if you want to list comments in a “sidebar” on your site and have them always be the same ones regardless of which page on your site you visit (main page, archives, comments, etc.). Using this, you can create a “recent comments” list. By setting dynamic=”no” you will ensure that the list is not affected by anything passed in the URL.

When dynamic is set to ‘no’, pagination will still function using an ‘N’ as a pagination indicator in the url rather than the standard ‘P’ indicator.

entry_id=¶

entry_id="24"

You can hard code the comment entries tag to show comments for a specific channel entry by its entry ID. You may also specify comments from multiple entries by separating them with the pipe character:

entry_id="13|42|147" Or use "not" to exclude entries::

entry_id="not 45|534|807"

comment_id=¶

comment_id="22"

You can hard code the comment entries tag to show specific comments. As with the entry_id parameter, you may also specify multiple comments by separating them with the pipe character. This parameter takes precedence over any entry specified in the url.

limit=¶

limit="30"

Allows you to limit the number of comments. The limit will default to 100 comments if a value is not specified. If you are using pagination then this will determine the number of comments shown per page.

orderby=¶

orderby="date"

The “order” parameter sets the display order of the comments. Setting options for this parameter include:

• orderby=”date”
• orderby=”email”
• orderby=”location”
• orderby=”name”
• orderby=”url”
• orderby=”random”

paginate=¶

paginate="top" paginate="bottom"  paginate="both"  paginate="inline"

This parameter is for use with entry pagination and determines where the pagination code will appear for your comments:

1. top: The navigation text and links will appear above your list of comments.
2. bottom: The navigation text and links will appear below your list of comments.
3. both: The navigation text and links will appear both above and below your list of comments.
4. inline: The navigation text and links will appear within the list of entries for each entry.

If no parameter is specified, the navigation block will default to the “bottom” behavior.

paginate_base=¶

paginate_base="site/index"

This tells ExpressionEngine to override the normal pagination link locations and point instead to the explicitly stated template group and template.

show_expired=¶

show_expired="yes"

You can determine whether you wish for comments on “expired” entries to be included.

sort=¶

sort="asc" ``sort="desc"``

The sort order can be “asc” (ascending order or “oldest item first” for dates) or “desc” (descending order or “newest item first” for dates). If you do not use a sort order the default is desc.

url_title=¶

url_title="my_wedding"

You can hard code the comment entries tag to show comments for a specific channel entry by its URL title.

channel=¶

channel="which"

From which channel to show the comments (will show comments from any channel if no channel is specified). Additionally, you can use the pipe character to separate multiple channels:

channel="channel1|channel2|channel3"

Or you can add the word “not” (with a space after it) to exclude channels:

channel="not channel1|channel2|channel3"

The channel= parameter can have some security implications. If you do not use this parameter then it is possible that people could see comments for a channel entry that they otherwise would not have access to. If you use multiple channels and want to make sure only certain people can see certain content, then you’re encouraged to make use of this parameter.

entry_status=¶

entry_status="Featured"

status=¶

status="Closed"

author_id=¶

author_id="5"

absolute_count¶

{absolute_count}

The absolute “count” out of the current comment being displayed by the tag, including those comments on previous pages (if using pagination).

If five entries are being displayed per page, then for the fourth entry on the second page the {absolute_count} variable would have a value of “9”.

author¶

{author}

The comment author’s screen name, if a member; otherwise, this variable will display the name submitted with the comment.

<a href="http://example.com/index.php/member/{author_id}/">{author}</a>

author_id¶

{author_id}

The ID corresponding to the comment author’s member profile. This is only applicable if the comment was left by a registered member. Non-registered commenters will return a zero (0).

This can be useful for creating links to the commenter’s member profile:

<a href="http://example.com/index.php/member/{author_id}/">{name}</a>

aol_im¶

{aol_im}

The author’s AOL IM account name

avatar_image_height¶

{avatar_image_height}

The height of the avatar image associated with the entry’s author. Typically used as such:

{if avatar} <img src="{avatar_url}" width="{avatar_image_width}" height="{avatar_image_height}" alt="{author}'s avatar" /> {/if}

avatar_image_width¶

{avatar_image_width}

The width of the avatar image associated with the entry’s author. Typically used as such:

{if avatar} <img src="{avatar_url}" width="{avatar_image_width}" height="{avatar_image_height}" alt="{author}'s avatar" /> {/if}

avatar_url¶

{avatar_url}

The URL to the avatar image associated with the entry’s author. Typically used as such:

{if avatar} <img src="{avatar_url}" width="{avatar_image_width}" height="{avatar_image_height}" alt="{author}'s avatar" /> {/if}

can_moderate_comment¶

{if can_moderate_comment}

This variable will be used in a conditional to allow comment editing. It indicates whether a member has permission to edit a given comment AND/OR close that comment.

channel_short_name¶

{channel_short_name}

The short name of the channel of that the comment belongs to.

channel_title¶

{channel_title}

This variable simply displays the content from the “Full Channel Name” setting of the channel that the comment belongs to.

comment¶

{comment}

The body of the comment

comment_stripped¶

{comment_stripped}

The body of the comment without any typographical processing and with ExpressionEngine tags encoded. This tag is for use in comment editing.

comment_auto_path¶

{comment_auto_path}

This variable is replaced by the URL set in the Comment Page URL preference under Admin ‣ Channel Management. No entry id, URL Title, or other information is included; this is simply the exact URL from the preference.

comment_date¶

{comment_date format="%Y %m %d"}

The date of the comment. See Date Variable Formatting for more information.

comment_entry_id_auto_path¶

{comment_entry_id_auto_path}

This variable is replaced by the URL set in the Comment Page URL preference under Admin ‣ Channel Management. The ID number of the entry will be automatically added. For example, this:

<a href="{comment_entry_id_auto_path}">my entry</a>

Would be rendered like this:

<a href="http://example.com/index.php/channel/comments/234/">my entry</a>

comment_id¶

{comment_id}

The ID associated with the comment

comment_site_id¶

{comment_site_id}

The Site ID for the comment.

comment_url_title_auto_path¶

{comment_url_title_auto_path}

This variable is replaced by the URL set in the Comment Page URL preference under Admin ‣ Channel Management. The URL Title of the entry will be automatically added. For example, this:

<a href="{comment_url_title_auto_path}">my entry</a>

Would be rendered like this:

<a href="http://example.com/index.php/channel/comments/ice_cream/">my entry</a>

count¶

{count}

The “count” out of the current comment being displayed by the tag on the current page.

If five entries are being displayed per page, then for the fourth entry on the page the {count} variable would have a value of “4”.

editable¶

{if editable}Show Edit{/if}

This variable will be used in a conditional to allow comment editing. It indicates whether a member has permission to edit a given comment.

edit_date¶

{edit_date format="%Y %m %d"}

The date on which the comment was edited. See Date Variable Formatting for more information.

email¶

{email}

The comment author’s email address, if specified.

entry_author_id¶

{entry_author_id}

The member ID for the creator of the entry whose comments are being displayed.

entry_id¶

{entry_id}

The ID number of the entry

entry_id_path¶

{entry_id_path='channel/comments'}

The URL to the specified template. The ID number of the entry with which the comment is associated will be automatically added. For example, this:

<a href="{entry_id_path='channel/comments'}">my entry</a>

Would be rendered like this:

<a href="http://example.com/index.php/channel/comments/234/">my entry</a>

gmt_comment_date¶

{gmt_comment_date format="%Y %m %d"}

The date of the comment but not localized for the user. See Date Variable Formatting for more information.

icq¶

{icq}

The author’s ICQ IM user identification number

interests¶

{interests}

The author’s “interests” as entered in their profile

ip_address¶

{ip_address}

The IP address of the commenter

location¶

{location}

The commenter’s location as entered in their profile

group_id¶

{group_id}

The commenter’s member group id (0 for non-members)

member_search_path¶

{member_search_path='search/results'}

This variable is replaced by a URL that passes the author’s member name to your search results Template. In this way, you can display all entries made by the author. You should specify the Template_Group/Template that you use to display search results. For example:

<a href="{member_search_path='search/results'}">View entries by this member</a>

msn_im¶

{msn_im}

The author’s MSN IM account name

occupation¶

{occupation}

The author’s occupation as entered in their profile

name¶

{name}

Name of the author

paginate=¶

paginate="top" paginate="bottom"  paginate="both"  paginate="inline"

This parameter is for use with entry pagination and determines where the pagination code will appear for your entries:

1. top: The navigation text and links will appear above your list of entries.
2. bottom: The navigation text and links will appear below your list of entries.
3. both: The navigation text and links will appear both above and below your list of entries.
4. inline: The navigation text and links will appear within the list of entries for each entry.

If no parameter is specified, the navigation block will default to the “bottom” behavior.

permalink¶

{permalink}

The URL to the actual comment with anchor. Put this variable in a link:

<a href="{permalink}">permanent link</a>

photo_url¶

{photo_url}

This variable supplies the URL to the member photo (if you have that option enabled and the member has uploaded their photo). It is intended for use in an image tag.

photo_image_height¶

{photo_image_height}

This variable supplies the height of the member photo. It is intended for use in an image tag.

photo_image_width¶

{photo_image_width}

This variable supplies the width of the member photo. It is intended for use in an image tag.

signature¶

{signature}

The signature associated with the entry’s author. Typically used as such:

{if signature} <p>{signature}</p> {/if}

signature_image_height¶

{signature_image_height}

The height of the signature image associated with the entry’s author. Typically used as such:

{if signature_image} <img src="{signature_image_url}" width="{signature_image_width}" height="{signature_image_height}" alt="{author}'s signature" /> {/if}

signature_image_url¶

{signature_image_url}

The URL to the signature image associated with the entry’s author. Typically used as such:

{if signature_image} <img src="{signature_image_url}" width="{signature_image_width}" height="{signature_image_height}" alt="{author}'s signature" /> {/if}

signature_image_width¶

{signature_image_width}

The width of the signature image associated with the entry’s author. Typically used as such:

{if signature_image} <img src="{signature_image_url}" width="{signature_image_width}" height="{signature_image_height}" alt="{author}'s signature" /> {/if}

switch=¶

{switch="option_one|option_two|option_three"}

This variable permits you to rotate through any number of values as the entries are displayed. The first entry will use “option_one”, the second will use “option_two”, the third “option_three”, the fourth “option_one”, and so on.

The most straightforward use for this would be to alternate colors. It could be used like so:

{exp:comment:entries} <div class="{switch="one|two"}"> <h1>{name}</h1> {comment} </div> {/exp:comment:entries}

The entries would then alternate between <div class=”one”> and <div class=”two”>.

Multiple instances of the {switch=} tag may be used and the system will intelligently keep track of each one.

title¶

{title}

The title of the channel entry with which the comment is associated.

total_results¶

{total_results}

The total number of comments being displayed by this tag on the current page.

total_comments¶

{total_comments}

The total number of comments for this tag on all pages.

url¶

{url}

The author’s raw URL, if it exists

url_as_author¶

{url_as_author}

Hyperlink pointing to the URL (if it exists) with the author name as the link title. If the URL does not exist simply the name is returned.

url_or_email¶

{url_or_email}

URL if it exists, otherwise the email address

url_or_email_as_author¶

{url_or_email_as_author}

Hyperlink or email link as author screen_name (or username if they haven’t specified a screen name)

url_or_email_as_link¶

{url_or_email_as_link}

Same as above only it will display the URL or email address as a link

url_title_path¶

{url_title_path='channel/comments'}

The URL to the specified template. The “url title” of the entry with which the comment is associated will be automatically added. For example, this:

<a href="{url_title_path='channel/comments'}">permalink</a>

Would be rendered like this:

<a href="http://example.com/index.php/channel/comments/ice_cream/">permalink</a>

username¶

{username}

The author’s username (returns FALSE for non-members)

channel_id¶

{channel_id}

The ID number of the actual channel

yahoo_im¶

{yahoo_im}

The author’s Yahoo IM account name

if avatar¶

{if avatar} content {/if}

This special conditional lets you conditionally display content if the current entry’s author has an avatar image specified.

{if avatar} <img src="{avatar_url}" width="{avatar_image_width}" height="{avatar_image_height}" alt="{author}'s avatar" /> {/if}

if is_ignored¶

{if is_ignored} content {/if}

This conditionals allows you to show (or hide) specific content if the comment was made by a member on the logged-in user’s ignore list. A simplified example of how this might be used is:

{exp:comment:entries}
        {if is_ignored}You are ignoring {author}.{/if}
        <div {if is_ignored}style="display: none;"{/if}>{comment}</div>
{/exp:comment:entries}

Or you can use Javascript to allow the user to read the comment if they wish:

<script type="text/javascript">
        function showHideComment(el) {
            if (document.getElementById(el).style.display == "block") {
                document.getElementById(el).style.display = "none";
            }
            else {
                document.getElementById(el).style.display = "block";
            }
        }
</script>

{exp:comment:entries}
        {if is_ignored}
            <p><a href="#" onclick="showHideComment('{comment_id}')">View / Hide</a> comment from ignored member: {author}</p>
        {/if}

        <div id="{comment_id}" {if is_ignored}style="display: none;"{/if}>{comment}</div>
{/exp:comment:entries}

if no_results¶

{if no_results} content {/if}

You may use this conditional for displaying a message in the case when no comments are returned. The contents inside of the conditional will be displayed in cases where there are no results returned for the tag.

{if no_results}  <p>There are no comments for this entry yet.</p>  {/if}

Further, you may specify that another Template be shown in a case when there are no results. In order to do that, you must use the redirect= variable:

{if no_results} {redirect="site/noresult"} {/if}

if signature_image¶

{if signature_image} content {/if}

This special conditional lets you conditionally display content if the current entry’s author has a signature image specified.

{if signature_image} <img src="{signature_image_url}" width="{signature_image_width}" height="{signature_image_height}" alt="{author}'s signature" /> {/if}

entry_id=¶

entry_id="24"

You can hard code the comment subscriber list tag to show subscribers for a specific channel entry by its entry ID.

exclude_guests=¶

exclude_guests="yes"

If you would like to exclude guest comments from the list and totals, set the exclude_guests parameter to “yes”. Comments made by non-members will not be included in the totals, and their email addresses will not be available for output to Super Admins.

subscriber_count¶

{subscriber_count}

The “count” out of the current subscriber being displayed by the tag. Also available simply as {count}, but using the prefixed version makes this variable safe to use inside of other tags that may have their own {count} variable.

subscriber_email¶

{subscriber_email}

The email address of the subscriber being displayed.

{if subscriber_is_member}
     {subscriber_screen_name}
{if:else}
     {encode="{subscriber_email}"}
{/if}

subscriber_guest_total¶

{subscriber_guest_total}

The total number of subscribers to an entry who are not registered members of the site.

subscriber_member_id¶

{subscriber_member_id}

The member ID of the subscriber being displayed. This will be “0” if the subscriber is a guest, so it is best to use this variable in a conditional.

subscriber_member_total¶

{subscriber_member_total}

The total number of subscribers to an entry who are registered members of the site.

subscriber_screen_name¶

{subscriber_screen_name}

The screen name of the subscriber. This will be empty if the subscriber is a guest, so it is best to use this variable in a conditional.

subscriber_total_results¶

{subscriber_total_results}

The total number of subscribers to an entry. Also available simply as {total_results}, but using the prefixed version makes this variable safe to use inside of other tags that may have their own {total_results} variable.

subscriber_is_member¶

{if subscriber_is_member}

The conditional allows you to show (or hide) content based on whether the subscriber is a registered member of the site.

entry_id=¶

entry_id="24"

You can hard code the comment form tag to display a comment form for a specific channel entry by its entry ID.

preview=¶

preview="channel/preview"

This is a required parameter if you are using comment previews indicating which template should be used for comment previews. Like other “path” variables in ExpressionEngine you will use the Template Group/Template name. More on previewing can be found in the Comment Previewing section.

url_title=¶

url_title="my_wedding"

You can hard code the comment for tag to display a comment form for a specific channel entry by its URL title.

channel=¶

channel="news"

With this parameter you can specify exactly which channel you want the submitted comment associated to. This is an important, but optional, parameter.

If you link to your comment form page using the entry’s URL Title, then you are strongly encouraged to include this parameter in your tag.

Because you can have the same URL Title in different channels, using this parameter will ensure that the comment submitted will be associated with the correct entry. Without this parameter, it is possible that the comment could be associated with an entry in a different channel that happens to have the same URL Title.

form_class=¶

form_class="news_comment_form"

With this parameter, you can specify the css class you want the form to have, enabling fine-grained styling of the comment form.

form_id=¶

form_id="news_comment_form"

With this parameter, you can specify the css id you want the form to have. The default value is ‘comment_form’

return=¶

return="template_group/template/url_title"

This parameter allows you to define where the user will be returned after submitting a comment. The parameter can be defined in two ways:

1. Use the standard Template_Group/Template syntax to specify where to return the user. For instance, if you want the user to be returned to the “local” Template in the “news” Template Group, you would use: return=”news/local”
2. Use a full URL. For example: return=”http://example.com/return.html”

If this parameter is not defined, they will be returned to the form page.

logged_out¶

{if logged_out}

The conditional variable {if logged_out} allows the system to show the short form (textarea only) if the user is a logged in member. We recommend you use the form this way because if a member is logged in, their personal data is fetched automatically.

captcha¶

{if captcha}

As noted in the captcha section, the contents of the conditional ({if captcha}) tag will only appear if you have the CAPTCHA preference turned on for comments in the channel the entry is associated with.

comments_expired¶

{if comments_expired}

If commenting has expired (and expiration is not set to be overridden by moderation), the contents of this conditional will replace all other tag contents.

comments_disabled¶

{if comments_disabled}

If commenting has been disabled, the contents of this conditional will replace all other tag contents.

comment¶

{comment}

The body of the comment.

comment_date¶

{comment_date format="%Y %m %d"}

The date of the comment. As with other date variables, this requires the “format” parameter in order to define how the date should be displayed. See the date variable formatting page for more information.

email¶

{email}

The email address of the comment author.

location¶

{location}

The author’s location as entered in their profile or the comment entry form.

name¶

{name}

Name of the author.

url¶

{url}

The author’s raw URL, if it exists.

url_as_author¶

{url_as_author}

Hyperlink pointing to the URL (if it exists) with the author name as the link title. If the URL does not exist simply the name is returned.

url_or_email¶

{url_or_email}

URL if it exists, otherwise the email address.

url_or_email_as_author¶

{url_or_email_as_author}

Hyperlink or email link as author screen_name (or username if they haven’t specified a screen name).

url_or_email_as_link¶

{url_or_email_as_link}

Same as above only it will display the URL or email address as a link.

Conditionals¶

The following conditionals are available:

• {if email}
• {if location}
• {if logged_in}
• {if logged_out}
• {if name}
• {if url}