Commented Entries

Developer

Laisvunas

3rd Party (Commercial)


EE Version Support

  • ExpressionEngine 1.x
  • ExpressionEngine 2

Compatibility

If an item is crossed out, it might be untested, not applicable or incompatible. Contact the developer to be sure.

  • Updater
  • Multi Site Manager
  • Stand Alone Entry Form
  • Low Variables
  • Content Elements
  • Better Workflow
  • Matrix
  • Grid
  • Webservice
  • Publisher

Requirements

  • jQuery for the Control Panel

Add-On Type(s)

Plugin

Tags

This plugin allows you to display a list of commented entries. Supports both usual pagination and loading pages via AJAX.

I. PARAMETERS
 
  1) site - Optional. Allows you to specify site id number.
You can stack site id numbers using pipe character to get entries
from any of those sites, e.g. site=“1|3”. Or use “not”
(with a space after it) to exclude sites, e.g. site=“not 1|2”.
 
  2) weblog (for EE1.x) - Optional. Allows you to specify weblog name.
You can use the pipe character to get entries from any of those
weblogs, e.g. weblog=“weblog1|weblog2|weblog3”.
Or you can add the word “not” (with a space after it) to exclude weblogs,
e.g. weblog=“not weblog1|weblog2|weblog3”. You also can use weblog ids
instead of weblog names as the values of this parameter; you can even
mix weblog names and weblog ids, e.g. weblog=“weblog1|10|weblog2|15|weblog3”.

  3) channel (for EE2.0+) - Optional. Allows you to specify channel name.
You can use the pipe character to get entries from any of those
channels, e.g. channel=“channel1|channel2|channel3”.
Or you can add the word “not” (with a space after it) to exclude channels,
e.g. channel=“not channel1|channel2|channel3”. You also can use weblog ids
instead of channel names as the values of this parameter; you can even
mix channel names and channel ids, e.g. channel=“channel1|10|channel2|15|channel3”.
 
  4) category - Optional. Allows you to specify category id number
(the id number of each category is displayed in the Control Panel).
You can stack categories using pipe character to get entries
with any of those categories, e.g. category=“3|6|8”. Or use “not”
(with a space after it) to exclude categories, e.g. category=“not 4|5|7”.
 
  5) status - Optional. Allows you to specify status of entries. You can choose multiple
statuses using a pipe status=“draft|reviewed|published” or exclude statuses using “not”
status=“not submitted|processing|closed”.
 
  6) entry_id - Optional. Allows you to specify entry_id of entries. You can specify multiple
  entry_ids using pipe, e.g. entry_id=“101|109|12|136” or exclude entry_ids using “not”,
  e.g. entry_id=“not 101|109|12|136”.
 
  7) entry_series - Optional. Allows you to specify pipe delimited series of
entry ids, e.g. entry_series=“78|95|54|22|156”. Entries will be outputted exactly
in the same order. You also can specify up to 50 pipe delimited series of
entry ids using parameters entry_series_1, entry_series_2, entry_series_3 ...
entry_series_48, entry_series_49, entry_series_50.
 
  8) orderby - Optional. This parameter sets the display order of the entries.
Possible values are “date”, “title”, “edit_date”, “comment_total”, “recent_comment_date”,
“screen_name”. Default is “date”.
 
  9) sort - Optional. Allows you to specify sort order.
Sort order can be ascending (sort=“asc”) or descending (sort=“desc”).
Default is descending.

NOTE: The orderby=”” and sort=”” parameters can accept multiple values using the pipe character.
This allows you to have multiple levels of ordering and then specify the sort rules for those levels.
For example, if you wish to order by screen_name alphabetically and then have the most recent entries first, you would use the following parameters:
orderby=“screen_name|date” sort=“asc|desc”
 
  10) expired_entries - Optional. Allows you to specify if expired entries should be displayed.
  Possible values are “yes” and “no”. Default is “no”.
 
  11) expired_comments - Optional. Allows you to specify if expired comments should be counted.
  Possible values are “yes” and “no”. Default is “no”.
 
  12) limit - Optional. Allows you to specify number of entries to be displayed. Default value is “10”.
  To display all commented entries set the value of this parameter to “none”.
 
  13) per_page - Optional. Allows you to specify how many
items should be displayed on one page. Default value is “10”. This parameter should net be confused with
“limit” parameter.
 
  14) date_format - Optional. Allows you to specify how date should be formatted.
Use ExpressionEngine’s date formatting code.
 
  15) date_localize - Optional. Allows you to specify if the date should be localized.
Possible values are “yes” and “no”. Default is “no”.

  16) time_span_entries - Optional. Allows you to specify number of days from now.
  E.g. time_span_entries=“14” means that plugin will display commented entries posted
  during the last 14 days.
 
  17) time_span_comments - Optional. Allows you to specify number of days from now.
  E.g. time_span_comments=“21” means that plugin will display commented entries which have comments submitted
  during the last 21 days.
 
  18) max_pagination_links - Optional. Allows you to specify how many pagination links should be
displayed. Default value is “2”.

  19) ajax_pagination - Optional. Allows you to specify if using pagination the pages
  should be loaded via ajax. Possible values are “yes” and “no”. Default is “no”.
 
  20) ajax_namespace - Optional. Used in case you add several exp:commentries tag on one teplate
  each having parameter ajax_pagination=“yes”. In such case each exp:commentries tag *must* have
  parameter “ajax_namespace” with unique string as its value.
 
  21) ajax_post_vars - Optional. Allows you to specify pipe delimited list of POST variable names which will be
  sent by AJAX. E.g. ajax_post_vars=“my_var_1|my_var_2”.
 
  22) ajax_post_values - Optional. Allows you to specify pipe delimited list of POST variable values which will be
  sent by AJAX. E.g. ajax_post_values=“my_value_1|my_value_2”. On the template which will be used by AJAX those POST
  variables can be outputted by some other add-on, e.g. by “GET/POST Parameters” plugin available at http://devot-ee.com/add-ons/get-post-parameters/.
 
  23) ajax_template_url - Optional. Allows you to specify template group name and template name
  (those names shoul be separated by slash) of the template which will be used by AJAX.
 
  24) ajax_container_id - Optional. Allows you to specify CSS id parameter of the HTML element
inside which AJAX should output commented entries list.
 
  25) progress_indicator_id - Optional. Allows you to specify CSS id parameter of the HTML element
which will act as the indicator of commented entries list being loaded via AJAX.
 
  26) progress_indicator_class - Optional. Allows you to specify CSS class parameter of the HTML element
which will act as the indicator of commented entries list being loaded via AJAX.
 
  27) error_message_container_id - Optional. Allows you to specify CSS id parameter of the HTML element
inside which an error message will be outputted in case pulling list of commented entries by AJAX fails.
 
  28) error_message_container_class - Optional. Allows you to specify CSS class parameter of the HTML element
inside which an error message will be outputted in case pulling list of commented entries by AJAX fails.

  29) ajax_add_callback - Optional. Allows you to specify name of javascript function which
will be executed when AJAX response will be outputted into container after clicking of some pagination link.
This parameters supports pipe character, i.e. you can add several callback functions.

  30) any name of javascript function which is used inside the value of “ajax_add_callback” parameter
  can be used as the name of a new parameter. The value of this parameter will
be used as argument of the relevant javascript function. E.g. if you have parameter ajax_add_callback=“my_callback”,
then you can add parameter my_callback=“5”; the number “5” will be used as the argument for “my_calback” function.
In case you need to call a function with several arguments, use javascript object.  E.g. if you have parameter
ajax_add_callback=“new_callback”, then you can add parameter new_callback=’{“value1”: null, “value2”: “some_string”}’.
 
  31) invalid_input - Optional. Accepts two values: “alert” and “silence”.
Default value is “silence”. If the value is “alert”, then in cases when some
parameter’s value is invalid plugin exits and PHP alert is being shown;
if the value is “silence”, then in cases when some parameter’s value
is invalid plugin finishes its work without any alert being shown.
Set this parameter to “alert” for development, and to “silence” - for deployment.
 
II. SINGLE VARIABLES
 
  1) commentries_title - outputs title of the entry.
 
  2) commentries_entry_id - outputs ID number of the entry.
 
  3) commentries_url_title - outputs url title of the entry.
 
  4) commentries_status - outputs status of the entry.
 
  5) commentries_entry_date - outputs date when the entry was submitted.
 
  6) commentries_weblog_id (for EE1.x) - outputs ID number of the weblog into which an entry was
posted.
 
  7) commentries_weblog_name (for EE1.x) - outputs short name of the weblog into which an entry was
posted.
 
  8) commentries_weblog_title (for EE1.x) - outputs title of the weblog into which an entry was
posted.

  9) commentries_weblog_url (for EE1.x) - outputs weblog url as specified in Control Panel.
 
  10) commentries_weblog_id (for EE2.0+) - outputs ID number of the weblog into which an entry was
posted.
 
  11) commentries_weblog_name (for EE2.0+) - outputs short name of the weblog into which an entry was
posted.
 
  12) commentries_weblog_title (for EE2.0+) - outputs title of the weblog into which an entry was
posted.

  13) commentries_weblog_url (for EE2.0+) - outputs weblog url as specified in Control Panel.
 
  14) commentries_author_name - outputs screen name of the entry’s author.
 
  15) commentries_comments_number - outputs number of comments posted in relevant entry.
 
  16) commentries_total - outputs number of commented entries displayed on current page.
 
  17) commentries_absolute_total - outputs number of commented entries displayed on all
  pages (if pagination is being used).
 
  18) commentries_count - outputs count number of commented entry on current page.
 
  19) commentries_absolute_count - outputs absolute count number of the entries being
displayed by the tag, including those entries on previous pages (if using pagination).
 
  III. VARIABLE PAIRS
 
  1) {commentries_no_results}{/commentries_no_results} - contents of this variable pair
  will be outputted in case no commented entries were found by exp:commentries tag.
 
  2) {commentries_pagination_top}{/commentries_pagination_top}
 
  3) {commentries_pagination_bottom}{/commentries_pagination_bottom}
 
  Variables available for use within these last two variable pairs are:
 
  1) {commentries_current_page}
 
  2) {commentries_total_pages}
 
  3) {commentries_pagination_links}
 
  IV. EXAMPLE (NOT USING AJAX)

<html>

<head>

<title>Commented Entries demo (without using AJAX)</title>

</head>

<body>

<h2>Commented Entries demo (without using AJAX)</h2>

{exp:commentries channel="my_channel1|my_channel2" category="6" orderby="most_recent_comment" sort="desc" limit="none" per_page="5" parse="inward"}

{commentries_absolute_count}. Author: {commentries_author_name}. Title: {commentries_title}. Channel: {commentries_weblog_title}. url_title: {commentries_url_title}. Comments: {commentries_comments_number}<br><br>

{commentries_pagination_bottom}<p> Page {commentries_current_page} of {commentries_total_pages} {commentries_pagination_links}{/commentries_pagination_bottom}

{/exp:commentries}

</body>

</html>

V. EXAMPLE (USING AJAX)

a) Code in the main template:

<html>

<head>

<title>Commented Entries demo (using AJAX)</title>

<style>
.pagination a {
cursor: pointer;
color:blue;
}

.pagination a:hover {
text-decoration:underline;
}

div.progress_indicator {
border: solid 1px green;
background-image: url({site_url}{globalvar_interface_images_uri}ajax-loader.gif);
background-repeat: no-repeat;
background-position: center;
height: 7em;
width: 35em;
text-align: center;
display: block!important;
}

div.indicator  {
display: none;
}

.ajax_error {
border: solid 1px red;
height: 7em;
width: 35em;
display: block!important;
}
</style>

</head>

<body>

<h2>Commented Entries demo (using AJAX)</h2>

<div id="latest_comments_progress_indicator" style="display: none">
<h2>Loading commented entries list…</h2>
</div>

<div id="latest_comments_error_message" style="display: none">
<h2>Error occurred:</h2>
</div>

{embed="technical/embed_commentedEntries" category_id="6" ajax_post_vars="category_id" ajax_post_values="6"}

</body>

</html>

b) Code in the embedded template:


<div id="comments_latest">
{exp:get_post_vars parse="inward"}
{exp:commentries channel="my_channel1|my_channel2" category="{embed:category_id}{post_category_id}" orderby="most_recent_comment" sort="desc" limit="none" per_page="5" ajax_pagination="yes" ajax_namespace="LatestComments" ajax_post_vars="{embed:ajax_post_vars}" ajax_post_values="{embed:ajax_post_values}" ajax_template_url="technical/embed_commentedEntries" ajax_container_id="comments_latest" progress_indicator_id="latest_comments_progress_indicator" progress_indicator_class="progress_indicator" error_message_container_id="latest_comments_error_message" error_message_container_class="ajax_error" invalid_input="alert" parse="inward"}

{commentries_absolute_count}. Author: {commentries_author_name}. Title: {commentries_title}. Channel: {commentries_weblog_title}. url_title: {commentries_url_title}. Comments: {commentries_comments_number}<br><br>

{commentries_pagination_bottom}<p class="pagination"> Page {commentries_current_page} of {commentries_total_pages} {commentries_pagination_links}{/commentries_pagination_bottom}

{/exp:commentries}
{/exp:get_post_vars}
</div>

Commented Entries Links

This entry was created June 23, 2010, 12:21 pm.
This entry was last updated September 28, 2011, 9:57 pm.

Disclaimer: Information about ExpressionEngine add-ons is provided as a service to you, the user, and every member of the ExpressionEngine community. devot:ee is not responsible if you hose, mangle, wreck, or otherwise destroy your EE website by installing an add-on that you found out about at this site, regardless of its rating, Favorites status, commercial or free status, or general popularity. Caveat EEmptor!

Returns: devot:ee has a 30-day return policy on all commercial add-ons sold through devot-ee.com. If you need to return an add-on, do not go to the developer or the developer's site, but rather visit our returns page at https://devot-ee.com/returns to initiate your return. If you have questions, email support@devot-ee.com.

1 Review:

gabocseri 04.06.13

gabocseri
Rating - {addon_rating_average}

Works absolutely smooth and easy, for 12$ this add-on saved me a great amount of time and my template remained clear. Thank you! Absolutely satisfied! Recommended!