Plugin: Entries List
Development and Programming
The attached add-on files may be out of date. Please visit Devot-ee for the latest versions.
For use to build easily menus, contents and previous/next linking.
PARAMETERS (All optional) :
1) category - category id. “|” “not”, “&” supported. 2) weblog - weblog name. “|”, “not” supported. 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. 3) entry_series - 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. At least one out of “category”, “weblog”, “entry_series” parameters must be defined. 4) status 5) entry_id 6) sort - “asc” or “desc”. 7)orderby “date” or “title”. Default “date”. 8) site - site id. “|”, “not” supported. 9) per_page - how many items should be displayed on page. This parameter should not be confused with “limit” parameter. 10) limit - number of entries to be displayed. If “sort_separately” parameter has the value “weblogs” or “entries”, then the value of “limit” parameter applies to each weblog or category separately. “limit” parameter specifies how many items should be displayed at all, that is on all pages if there will be pagination. 11) date_format - ExpressionEngine’s date formatting code. 12) date_localize - specify if the date should be localized. Possible values - “yes” and “no”. Default “no”. 13) invalid_input - accepts two values: “alert” and “silence”. Default is “silence”. 14) aliases_only - accepts two values: “yes” and “no”. Default is “no”. If the value is “yes”, then variables {title}, {url_title}, {category_name} and {weblog_short_name} 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) which parses these variables. 15) on_failure - 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 - accepts two values: “weblogs” and “categories”. If the value is “weblogs”, then entries will be sorted for each weblog separately; if the value is “categories”, then entries will be sorted for each category separately. This parameter having the value “weblogs” has the effect only if “weblog” 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 - for use together with “sort_separately” parameter. It allows to specify which weblog or category counting should start from. You can use pipe character to stack several weblog short names or several category id numbers. 18) count_stop_before - for use together with “sort_separately” parameter. In case the latter has the value “weblogs”, it allows you to specify which weblog counting should stop before. You can use pipe character to stack several weblog short names or several category id numbers. 19) max_links - how many pagination links should be displayed. Default value is “2”.
VARIABLES:
1) entries_list_weblog_id 2) weblog_name 3) weblog_short_name - has alias {entries_list_weblog_short_name}. 4) weblog_url - outputs weblog url as specified in weblog preferences. 5) url_title - has alias {entries_list_url_title}. 6) category_name - has alias {entries_list_category_name}. 7) category_url_title - has alias {entries_list_category_url_title}. 8) title - has alias {entries_list_title}. 9) entry_id - has alias {entries_list_entry_id}. 10) entries_list_status 11) entry_date - has alias {entries_list_entry_date}. Can have “date_format” parameter. 12) entries_list_total_results 13) entries_list_count 14) entries_list_absolute_count 15) entries_list_separate_count 16) entries_list_weblog_count 17) entries_list_category_count 18) entries_list_entry_series_count 19) next_entry_id 20) next_entry_title 21) next_entry_url_title 22) next_entry_weblog_url 23) next_entry_weblog_name 24) next_entry_weblog_id 25) next_entry_weblog_shortname 26) next_entry_date - can have “date_format” parameter. 27) next_entry_weblog_count 28) next_entry_category_count 29) next_entry_entry_series_count 30) previous_entry_id 31) previous_entry_title 32) previous_entry_url_title 33) previous_entry_weblog_url 34) previous_entry_weblog_name 35) previous_entry_weblog_id 36) previous_entry_weblog_shortname 37) previous_entry_date - can have “date_format” parameter. 38) previous_entry_weblog_count 39) previous_entry_category_count 40) previous_entry_entry_series_count 41) entries_list_weblog_count_total 42) entries_list_category_count_total 43) entries_list_entry_series_count_total 44) entries_list_sort_separately_iteration
VARIABLE PAIRS
1) {entries_list_area}{/entries_list_area} 2) {entries_list_paginate_top}{/entries_list_paginate_top} 3) {entries_list_paginate_bottom}{/entries_list_paginate_bottom}
Variables available for use within 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" weblog="not weblog1|weblog4" 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 weblog_short_name!="weblog3"}
<a >{title}</a>
{if:else}
<a >{category_name}: {title}</a>
{/if}
{/exp:entries_list}
Nice work!
Hi Victor,
Whats the difference between this plugin and: {exp:weblog:entries weblog="something" category="16" disable="all_the_useless_stuff"} Except that your plugin “maybe” faster.
There are two differences:
1) using {exp:weblog:entries} even with disable=”all_the_useless_stuff” I was never able to pull more than about 250 entries. Using Category Posts plugin I’m successfully pulling more than 500 and this does not seems to be a limit. (My PHP memory amount is 64MB)
2) using {exp:weblog:entries} you cannot pull weblog path which is set in weblog preferences. To set href attribute for links you must use {path=template_group/template} variable. This is very constricting if you need to pull entries from several weblogs and display them using different templates. Using Category Posts plugin you can use {weblog_url} variable which pulls weblog path from weblog preferences.
And btw.. maybe add site=”” I have seen a lot of clients jumping on the MSM feature..and i hope all the developers try and make their plugin MSM compatible.
A good suggestion. I will add this feature in the next version of the plugin.
I have updated the plugin Entries List. You can download version 1.1 using the link in the first post in this thread.
In this release the bug - weblog_name variable displaying weblog short name instead of full weblog name - was fixed.
Also the new parameter - ‘site’ - was added. This parameter 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”.
“Category” parameter was made optional. Now at least one out of “category” and “weblog” parameters must be defined.
Plugin’s name changed from “Category posts” to “Entries list”. Older name and “category” parameter being made required reflected more how I was initially intending to use this plugin, not what really could be done using the function wrapped in this plugin. Now the functionality and name are more in sync.
You can use updated plugin to make various lists of entries - such as lists of contents or menus.
I have updated the plugin Entries List. You can download version 1.2 using the link in the first post in this thread.
In this release a new parameter - limit - was added. Using this parameter you can specify how many entries you want to be displayed. Without this parameter all entries posted into weblogs and categories as specified by “weblog” and “category” parameters will be displayed.
Hi,
I have released a version 1.3 of Entries List plugin.
In this release parameter “invalid_input” was added. This parameter 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 the plugin finishes its work without any alert being shown. Set this parameter to “alert” for development, and to “silence” - for deployment.
Since the plugin does not do comprehensive validation of parameters’ values, you cannot be absolutely sure that in cases no alert was thrown the input was really valid.
I have released a version 1.4 of Entries List plugin.
New features are “aliases_only” parameter and aliases to {title}, {url_title} and {category_name} variables.
These features were introduced to get Entries List plugin working correctly when it is used inside some tag (e.g exp:weblog:entries) which also parses these variables.
Now in order to avoid parsing of {title}, {url_title} and {category_name} variables by some ExpressionEngine’s tag it is possible to use aliases of these variables - {entries_list_title}, {entries_list_url_title} and {entries_list_category_name}.
To avoid parsing of {title}, {url_title} and {category_name} variables by Entries List plugin, “aliases_only” parameter shoul be used. This parameter accepts two values: “yes” and “no”. Default value is “no”. If the value is “yes”, then variables {title}, {url_title} and {category_name} 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 “aliases_only” parameter to “no” and use only aliases of {title}, {url_title} and {category_name} variables if you include {exp:entries_list} tag inside some other tag which parses these variables.
I have released a version 1.5 of Entries List plugin.
New features are support for conditionals and a new variable - {weblog_short_name}.
Now it is possible to write the code as this:
{exp:entries_list category="6" weblog="not weblog1|weblog4" sort="asc" site="1"}
{if weblog_short_name=="weblog3"}
<a href="{weblog_url}{url_title}">{title}</a>
{if:else}
<a href="{weblog_url}{url_title}">{category_name}: {title}</a>
{/if}
{/exp:entries_list}Hi,
I have released version 1.6 of Entries List plugin.
In this version a bug was fixed - uncategorized entries not being shown when “weblog” parameter is being used without “category” parameter.
Thanks jguip for reporting this bug.
Also a new variable - {entry_id} was added together with its alias {entries_list_entry_id}.
Hi,
I have released version 1.7 of Entries List plugin.
In this version a new parameter - on_failure - was added.
This optional parameter allows you to specify what exp:entries_list tag should output in case no entry was found. By default the tag in such case will output nothing. 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. You may need to set this parameter to “tagdata” in cases when exp:entries_list tag wraps some other tags.
Hi,
I have released version 1.8 of Entries List plugin.
In this release:
1) entry_id parameter was added. Pipe character is not supported. Use this parameter when you need to display single entry.
2) new variables were added:
{next_entry_id} - outputs entry id number of the next entry in the list.
{next_entry_title} - outputs title of the next entry in the list.
{next_entry_url_title} - outputs url title of the next entry in the list.
{next_entry_weblog_url} - outputs weblog url of the next entry in the list.
{previous_entry_id} - outputs entry id number of the previous entry in the list.
{previous_entry_title} - outputs title of the previous entry in the list.
{previous_entry_url_title} - outputs url title of the previous entry in the list.
{previous_entry_weblog_url} - outputs weblog url of the previous entry in the list.These variables can be used for Previous/Next entry linking.
Hi,
I released version 1.9 of Entries List plugin.
In this release:
1) parameters “date_format” and “date_localize” were added. date_format parameter allows you to specify how date should be formatted. About date formatting see here. date_localize parameter allows you to specify if the date should be localized. Possible values are “yes” and “no”. Default is “no”.
2) {entry_date} variable and its alias {entries_list_entry_date}.
Hi,
I released version 2.0 of Entries List plugin.
In this release sort_separately parameter was added. It accepts two values: “weblogs” and “categories”. If the value is “weblogs”, then entries will be sorted for each weblog separately; if the value is “categories”, then entries will be sorted for each category separately. This parameter having the value “weblogs” has the effect only if “weblog” 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.
Hi,
I released version 2.0.1 of Entries List plugin.
In this release four new variables were added:
{next_entry_weblog_name} - outputs weblog name of the next entry in the list.
{next_entry_weblog_shortname} - outputs weblog short name of the next entry in the list.
{previous_entry_weblog_name} - outputs weblog name of the previous entry in the list.
{previous_entry_weblog_shortname} - outputs weblog short name of the previous entry in the list.Hi,
I released version 2.1 of Entries List plugin.
In this release a new variable - {entries_list_total_results} - were introduced. Use this variable to output number of entries found.