devot:eeDevoted to ExpressionEngine

PARAMETERS:

1) 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”.

2) weblog (for EE1.x) or channel (for EE2.0+) - Optional. Allows you to specify weblog name.
You can use the pipe character to get entries from any of those
weblogs/channels, e.g. weblog=“weblog1|weblog2|weblog3”.
Or you can add the word “not” (with a space after it) to exclude weblogs/channels,
e.g. weblog=“not weblog1|weblog2|weblog3”. You also can use weblog/channel ids
instead of weblog names as the values of this parameter; you can even
mix weblog/channel names and weblog/channel ids, e.g. weblog=“weblog1|10|weblog2|15|weblog3”.

3) 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.

At least one out of “category”, “weblog”, “channel” or “entry_series” parameters must be defined.

4) 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”.

5) url_title - Optional. Allows you to specify url_title of entries. You can choose multiple
url_titles using a pipe url_title=“one_url_title|another_url_title” or exclude statuses using “not”
url_title=“not one_url_title|another_url_title”.

5) entry_id - Optional. Allows you to specify entry id number.

6) sort - Optional. Allows you to specify sort order.
Sort order can be ascending (sort=“asc”) or descending (sort=“desc”).
Default is descending.

7)orderby - Optional. This parameter sets the display order of the entries.
Possible values are “date” and “title”. Default is “date”.

8) 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”.

9) per_page - Optional. Allows you to specify how many
items should be displayed on one page. This parameter should net be confused with
“limit” parameter.

10) limit - Optional. Allows you to specify number of entries to be displayed. If
“sort_separately” parameter has the value “weblogs”, “channels” or “entries” or “entry_series”, then the value of “limit”
parameter applies to each weblog or category or entry series separately. “limit” parameter should not be
cofused with “per_page” parameter. While “per_page” parameter specifies how many
items should be displayed on one page, the “limit” parameter specifies how many items
should be displayed at all, that is on all pages if there will be pagination.

11) date_format - Optional. Allows you to specify how date should be formatted.
Use ExpressionEngine’s date formatting code.

12) date_localize - Optional. Allows you to specify if the date should be localized.
Possible values are “yes” and “no”. Default is “no”.

13) 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 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.

14) aliases_only - Optional. Accepts two values: “yes” and “no”.
Default value is “no”. If the value is “yes”, then variables {title},
{url_title}, {entry_id}, {entry_date}, {weblog_short_name}, {channel_short_name}, 
{category_name}, {category_url_title} will not be parsed by the plugin;
only their aliases will be parsed. If the value is “no”, then both
variables {title}, {url_title} and {category_name} and their aliases
will be parsed. Set this parameter to “no” and use only aliases if
you include {exp:entries_list} tag inside some other tag (e.g
exp:weblog:entries/ exp:channel:entries) which parses these variables.

15) on_failure - Optional. Allows you to specify what exp:entries_list tag
should output in case no entry was found. If you set some string as the value of this parameter,
then that string will be outputted. If you set “tagdata” as the value of
this parameter, then the tag will output unmodified tagdata.

16) sort_separately - Optional. Accepts three values: “weblogs” (for EE1.x), “channels” (for EE2.0+), “categories” and “entry_series”.
If the value is “weblogs” or “channels”, then entries will be sorted for each weblog/channel separately;
if the value is “categories”, then entries will be sorted for each category separately.
This parameter having the value “weblogs” or “channels” has the effect only if “weblog” or “channel”
parameter value is without “not” operator and has at least one pipe character.
This parameter having the value “categories” has the effect only if “category”
parameter value is without “not” operator and has at least one pipe character.

17) count_start_on - Optional. For use together with “sort_separately” parameter.
In case the latter has the value “weblogs” or “channels”, it allows you to specify which
weblog/channel counting should start from. In case sort_separately” has the value “categories”,
it allows you to specify which category counting should start from. In case sort_separately” has the value “entry_series”,
it allows you to specify which entry_series counting should start from. You can use
pipe character to stack several weblog/channel short names or several category id numbers or severeal entry series names,
e.g. if count_start_on=“weblog3|weblog6|weblog10” then counting of weblogs/channels will
start when the plugin will output entry posted into any of those weblogs/channels;
if count_start_on=“entry_series_5|entry_series_6|entry_series_7” then counting of entry series will
start when the plugin will output entry posted into any of those entry series.

18) count_stop_before - Optional. For use together with “sort_separately” parameter.
In case the latter has the value “weblogs” or “channels”, it allows you to specify which
weblog/channel counting should stop before. In case sort_separately” has the value “categories”,
it allows you to specify which category counting should stop before. In case sort_separately” has the value “entry_series”,
it allows you to specify which entry_series counting should stop before. You can use
pipe character to stack several weblog/channel short names or several category id numbers or severeal entry series names,
e.g. if count_stop_before=“16|88|111” then counting of categories will stop before
the plugin will output entry posted into any of those categories;
if count_stop_before=“entry_series_10|entry_series_11|entry_series_12” then counting of entry series will
stop before the plugin will output entry posted into any of those entry series.

19) max_links - Optional. Allows you to specify how many pagination links should be
displayed. Default value is “2”.

20) field_name - Optional. Used when there is a need to display entries
having certain custom field equal to or not equal to or like
specific value.

21) field_value - Optional. Used when there is a need to display entries
having certain custom field equal to or not equal to or like specific value.

22) field - Optional. Used when there is a need to display entries having certain custom field
*not* equal or *like* to specific value. Acceps the value “include”, “exclude” and “like” (only entries
having field_name LIKE field_value will be displayed - SQL LIKE notation will be used).
Default value is “include”.

23) entries_start_on - Optional. You can specify a particular date/time on which to start the entries.
Only entries that are on or after this date will be included in the display.
The date/time must be specified in the following format: YYYY-MM-DD HH:MM
Here, YYYY is the four-digit year, MM is the two-digit month, DD is the two-digit day of the month,
HH is the two-digit hour of the day, and MM is the two-digit minute of the hour.
If the month, day, hour or minute has only one digit, precede that digit
with a zero. (E.g. “8.30 PM, March 9, 2004” would become “2004-03-09 20:30”.)
 
24) entries_stop_before - Optional. You can specify a particular date/time on which to end the entries.
Only entries that are before this date will be included in the display (entries exactly on this date/time will not be included).
The date/time must be specified in the following format: YYYY-MM-DD HH:MM
Here, YYYY is the four-digit year, MM is the two-digit month, DD is the two-digit day of the month,
HH is the two-digit hour of the day, and MM is the two-digit minute of the hour.
If the month, day, hour or minute has only one digit, precede that digit
with a zero. (E.g. “8.30 PM, March 9, 2011” would become “2011-03-09 20:30”.)

VARIABLES:

1) {entries_list_weblog_id} for EE1.x or {entries_list_channel_id} for EE2.0+ - outputs ID number of the weblog/channel.

2) {weblog_name} for EE1.x or {channel_name} for EE2.0+ - outputs the name of the weblog/channel into which an entry was
posted.

3) {weblog_short_name} for EE1.x or {channel_short_name} for EE2.0+ - outputs short name of the weblog/channel into which an entry was
posted. Alias of this variable is {entries_list_weblog_short_name} for EE1.x or {entries_list_channel_short_name} for EE2.0+.

4) {weblog_url} for EE1.x or {channel_url} for EE2.0+ - outputs weblog/channel url as specified in weblog preferences.

5) {url_title} - outputs url title of the entry. Alias of this variable is
{entries_list_url_title}.

6) {category_name} - outputs category name into which entry was posted.
(Only those category names will be displayed which satisfy condition
set in “category” parameter.) Alias of this variable is
{entries_list_category_name}.

7) {category_url_title} - outputs category url title
of the category into which entry was posted. Alias of this variable is
{entries_list_category_url_title}.

8) {title} - outputs title of entry. Alias of this variable is {entries_list_title}.

9) {entry_id} - outputs entry id number of the entry. Alias of this variable
is {entries_list_entry_id}.

10) {entries_list_status} - outputs staus of the entry.

11) {entry_date} - outputs entry date. Alias of this variable
is {entries_list_entry_date}. This variable can have “date_format” parameter. E.g.
{entries_list_entry_date date_format=”%Y-%m-%d”}

12) {entries_list_total_results} - outputs number of entries found.

13) {entries_list_count} - outputs count number of the entries being displayed.
If five entries are being displayed, then for the fourth entry the {entries_list_count}
variable would have a value of “4”.

14) {entries_list_absolute_count} - absolute count number of the entries being
displayed by the tag, including those entries on previous pages (if using pagination).
If five entries are being displayed per page, then for the fourth entry on the second page
the {entries_list_absolute_count} variable would have a value of “9”

15) {entries_list_separate_count} - used when parameter “sort_separately” has the value “weblogs” or “channels”
or “categories”. Outputs count number of the entries; entries of each weblog/channel or category are
counted separately.

16) {entries_list_weblog_count} for EE1.x or {entries_list_channel_count} for EE2.0+ - outputs count number (1, 2, 3 etc.) of the
weblog/channel whose entry is being displayed. Weblogs/channels are counted when parameter
“sort_separately” has the value “weblogs” for EE1.x or “channels” for EE2.0+.
Only non-empty weblogs/channel are counted.

17) {entries_list_category_count} - outputs count number (1, 2, 3 etc.) of the
entry_series to which entry belongs. Categories are counted when parameter
“sort_separately” has the value “categories”. Only non-empty categories are counted.

18) {entries_list_entry_series_count} - outputs count number (1, 2, 3 etc.) of the
entry series whose entry is being displayed. Entry series are counted when parameter
“sort_separately” has the value “entry_series”. Only non-empty entry series are counted.

19) {next_entry_id} - outputs entry id number of the next entry in the list.

20) {next_entry_title} - outputs title of the next entry in the list.

21) {next_entry_url_title} - outputs url title of the next entry in the list.

22) {next_entry_weblog_url} for EE1.x or {next_entry_channel_url} for EE2.0+ - outputs weblog/channel url of the next entry in the list.

23) {next_entry_weblog_name} for EE1.x or {next_entry_channel_name} for EE2.0+ - outputs weblog/channel name of the next entry in the list.

24) {next_entry_weblog_id} for EE1.x or {next_entry_channel_id} for EE2.0+ - outputs/channel weblog ID number of the next entry in the list.

25) {next_entry_weblog_shortname} for EE1.x or {next_entry_channel_shortname} for EE2.0+ - outputs weblog/channel short name of the next entry in the list.

26) {next_entry_date} - outputs date of the next entry. This variable can have “date_format” parameter. E.g.
{next_entry_date date_format=”%Y-%m-%d”}

27) {next_entry_weblog_count} for EE1.x or {next_entry_channel_count} for EE2.0+ - outputs count number (1, 2, 3 etc.) of the
weblog/channel into which next entry is posted. Weblogs/channels are counted when parameter
“sort_separately” has the value “weblogs” for EE1.x or “channels” for EE2.0+. Only non-empty weblogs/channels are counted.

28) {next_entry_category_count} - outputs count number (1, 2, 3 etc.) of the
category into which next entry is posted. Categories are counted when parameter
“sort_separately” has the value “categories”. Only non-empty categories are counted.

29) {next_entry_entry_series_count} - outputs count number (1, 2, 3 etc.) of the
entry_series to which next entry belongs. Entry series are counted when parameter
“sort_separately” has the value “entry_series”. Only non-empty entry series are counted.

30) {previous_entry_id} - outputs entry id number of the previous entry in the list.

31) {previous_entry_title} - outputs title of the previous entry in the list.

32) {previous_entry_url_title} - outputs url title of the previous entry in the list.

33) {previous_entry_weblog_url} for EE1.x or {previous_entry_channel_url} for EE2.0+ - outputs weblog/channel url of the previous entry in the list.

34) {previous_entry_weblog_name} for EE1.x or {previous_entry_channel_name} for EE2.0+ - outputs weblog/channel name of the previous entry in the list.

35) {previous_entry_weblog_id} for EE1.x or {previous_entry_channel_id} for EE2.0+ - outputs weblog/channel ID number of the previous entry in the list.

36) {previous_entry_weblog_shortname} for EE1.x or {previous_entry_channel_shortname} for EE2.0+ - outputs weblog/channel short name of the previous entry in the list.

37) {previous_entry_date} - outputs date of the next entry. This variable can have “date_format” parameter. E.g.
{previous_entry_date date_format=”%Y-%m-%d”}

38) {previous_entry_weblog_count} for EE1.x or {previous_entry_channel_count} for EE2.0+ - outputs count number (1, 2, 3 etc.) of the
weblog/channel into which previous entry is posted. Weblogs/channels are counted when parameter
“sort_separately” has the value “weblogs” for EE1.x or “channels” for EE2.0+. Only non-empty weblogs/channels are counted.

39) {previous_entry_category_count} - outputs count number (1, 2, 3 etc.) of the
category into which previous entry is posted. Categories are counted when parameter
“sort_separately” has the value “categories”. Only non-empty categories are counted.

40) {previous_entry_entry_series_count} - outputs count number (1, 2, 3 etc.) of the
entry_series to which previous entry belongs. Entry series are counted when parameter
“sort_separately” has the value “entry_series”. Only non-empty entry series are counted.

41) {entries_list_weblog_count_total} for EE1.x or {entries_list_channel_count_total} for EE2.0+ - outputs total number of weblogs/channels counted.
Weblogs/channels are counted when parameter “sort_separately” has the value “weblogs” for EE1.x or “channels” for EE2.0+.
Only non-empty weblogs/channels are counted.

42) {entries_list_category_count_total} - outputs total number of categories counted.
Categories are counted when parameter “sort_separately” has the value “categories”.
Only non-empty categories are counted.

43) {entries_list_entry_series_count_total} - outputs total number of entry series counted.
Entry series are counted when parameter “sort_separately” has the value “entry_series”.
Only non-empty entry series are counted.

44) {entries_list_sort_separately_iteration} - outputs iteration number (1, 2, 3 etc.) of
of the weblog or category being processed. Iteration number is assigned to weblogs/channels
when parameter “sort_separately” has the value “weblogs”  for EE1.x or “channels” for EE2.0+. Iteration number is assigned to
categories when parameter “sort_separately” has the value “categories”. Iteration
number is assigned both to empty and non-empty weblogs/channels and categories.

45) {first_entry_id} - outputs entry id number of the first entry.

46) {first_entry_url_title} - outputs url title of the first entry.

47) {first_entry_title} - outputs title of the first entry.

48) {first_entry_weblog_url} for EE1.x or {first_entry_channel_url} for EE2.0+ - outputs weblog url as specified in weblog preferences for the first entry.

49) {first_entry_weblog_name} for EE1.x or {first_entry_channel_name} for EE2.0+ - outputs the name of the weblog into which the first entry was
posted.

50) {first_entry_weblog_id} for EE1.x or {first_entry_channel_id} for EE2.0+ - outputs ID number of the weblog into which first entry was posted.

51) {first_entry_weblog_shortname} for EE1.x or {first_entry_channel_shortname} for EE2.0+ - outputs short name of the weblog into which first entry was
posted.

52) {first_entry_date} - outputs date of the first entry. This variable can have “date_format” parameter. E.g.
{first_entry_date date_format=”%Y-%m-%d”}

53) {first_entry_weblog_count} for EE1.x or {first_entry_channel_count} for EE2.0+ - outputs count number (1, 2, 3 etc.) of the
weblog into which first entry is posted. Weblogs are counted when parameter
“sort_separately” has the value “weblogs”. Only non-empty weblogs are counted.

54) {first_entry_category_count} - outputs count number (1, 2, 3 etc.) of the
category into which first entry is posted. Categories are counted when parameter
“sort_separately” has the value “categories”. Only non-empty categories are counted.

55) {first_entry_entry_series_count} - outputs count number (1, 2, 3 etc.) of the
entry_series to which first entry belongs. Entry series are counted when parameter
“sort_separately” has the value “entry_series”. Only non-empty entry series are counted.

56) {last_entry_id} - outputs entry id number of the last entry.

57) {last_entry_url_title} - outputs url title of the last entry.

58) {last_entry_title} - outputs title of the last entry.

59) {last_entry_weblog_url} for EE1.x or {last_entry_channel_url} for EE2.0+ - outputs weblog url as specified in weblog preferences for the last entry.

60) {last_entry_weblog_name} for EE1.x or {last_entry_channel_name} for EE2.0+ - outputs the name of the weblog into which the last entry was
posted.

61) {last_entry_weblog_id} for EE1.x or {last_entry_channel_id} for EE2.0+ - outputs ID number of the weblog into which last entry was posted.

62) {last_entry_weblog_shortname} for EE1.x or {last_entry_channel_shortname} for EE2.0+ - outputs short name of the weblog into which first entry was
posted.

63) {last_entry_date} - outputs date of the last entry. This variable can have “date_format” parameter. E.g.
{first_entry_date date_format=”%Y-%m-%d”}

63) {last_entry_weblog_count} for EE1.x or {last_entry_channel_count} for EE2.0+ - outputs count number (1, 2, 3 etc.) of the
weblog into which last entry is posted. Weblogs are counted when parameter
“sort_separately” has the value “weblogs”. Only non-empty weblogs are counted.

64) {last_entry_category_count} - outputs count number (1, 2, 3 etc.) of the
category into which last entry is posted. Categories are counted when parameter
“sort_separately” has the value “categories”. Only non-empty categories are counted.

65) {last_entry_entry_series_count} - outputs count number (1, 2, 3 etc.) of the
entry_series to which last entry belongs. Entry series are counted when parameter
“sort_separately” has the value “entry_series”. Only non-empty entry series are counted.

66) {entries_list_author_id} - outputs author id of the entry.

67) {entries_list_screen_name} - outputs entry author’s screen name.

VARIABLE PAIRS

1) {entries_list_area}{/entries_list_area} - used to delimit area which will be parsed by Entries List
plugin. Sometimes useful for control over parse order. E.g. If you have the code

{exp:entries_list category=“6” weblog=“not weblog1|weblog4” sort=“asc” site=“1”}
blah blah blah
{entries_list_area}
Some code
{/entries_list_area}
blah blah blah
{/exp:entries_list}

then Entries List plugin will parse only area inside {entries_list_area}{/entries_list_area} variable pair
and will leave everything else untouched.

2) {entries_list_paginate_top}{/entries_list_paginate_top} - used to output info and pagination on the
top of results page. Contents of this variable pair will be outputted one time.

3) {entries_list_paginate_bottom}{/entries_list_paginate_bottom} - used to output info and pagination on the
bottom of results page. Contents of this variable pair will be outputted one time.

Variables available for use within these last two variable pairs are:

1) {entries_list_current_page}

2) {entries_list_total_pages}

3) {entries_list_pagination_links}

EXAMPLE OF USAGE:

{exp:entries_list category="6" channel="not channel1|channel4" sort="asc" site="1"}

{entries_list_paginate_top}{if entries_list_pagination_links != ""}Page {entries_list_current_page} of {entries_list_total_pages} pages {entries_list_pagination_links}{/if}{/entries_list_paginate_top}

{if channel_short_name!="channel3"}
<a href={channel_url}{url_title}>{title}</a><br>
{if:else}
<a href={channel_url}{url_title}>{category_name}: {title}</a><br>
{/if}

{/exp:entries_list}