Favorites Documentation

Favorites:Entries template tag

The Favorites:Entries tag shows all entries that a member has saved. It can also be fed another users member ID or username to display a list of their favorites. If no member ID or username is provided, the currently logged-in member's favorites will be displayed.

{exp:favorites:entries} content {/exp:favorites:entries}

Parameters

Most of the parameters available in the Channel:Entries loop are available here. Additionally, these exist as well:

collection=

collection="articles"

This parameter allows you to display favorites filtered by the collection name. Specify multiples with the pipe character. If not specified, it'll show all entries, regardless of collection they belong to.

collection=

collection_id="1"

This parameter allows you to display favorites filtered by the collection ID. Specify multiples with the pipe character. If not specified, it'll show all entries, regardless of collection they belong to.

favorites_member_id=

favorites_member_id="{segment_3}"

This parameter allows you to display another user's favorites by hardcoding a member ID or pulling a member ID dynamically from the URL.

favorites_username=

favorites_username="{segment_3}"

This parameter allows you to display another user's favorites by hardcoding a username or pulling a username dynamically from the URL.

favorites_start_on=

favorites_start_on="2014-09-05 12:00 PM"

You can specify a particular date/time on which to start the entries. Only entries that were saved to favorites on or after this date will be included in the results. Can be used in conjunction with the favorites_stop_before parameter for limiting the results to a specific date range.

favorites_stop_before=

favorites_stop_before="2014-09-12 12:00 PM"

You can specify a particular date/time on which to end the entries. Only entries that were saved to favorites before this date will be included in the results (entries exactly on this date/time will not be included). Can be used in conjunction with the favorites_start_on parameter for limiting the results to a specific date range.

limit=

limit="25"

This parameter allows you to determine the maximum number of results you want to show on the page.

orderby=

orderby="favorited_date"

This parameter sets the display order of the entries. You can use any of the options available with Channel:Entries, or additionally you can use favorited_date, which orders the results based on the date each entry was last saved as a favorite.

paginate=

paginate="both"

This parameter allows you to control where the pagination will display. Options are top, bottom, or both. Used in conjunction with the favorites:paginate variable pair.

sort=

sort="asc"

This parameter sets the sort order to be ascending (asc) or descending (desc). Default order is desc.

Variables

Most of the variables available in the Channel:Entries loop are available here. Collection name, date and notes can be generated by nesting the Favorites:Info tag inside this one. Additionally, these exist as well:

favorites:absolute_count

{favorites:absolute_count}

This variable outputs the display order number for each result in the list of entries (across all pages, if using pagination).

favorites:absolute_results

{favorites:absolute_results}

This variable will return the absolute total amount of entry results. This includes all entries across all pages when pagination is used.

favorites:count

{favorites:count}

This variable outputs the display order number for each result in the list of entries (within the page, if using pagination).

favorites:total_results

{favorites:total_results}

This variable outputs the total amount of entries in the results (within the page, if using pagination). You would typically use this in a conditional statement.

Variable Pairs

The following variable pairs are available for use:

favorites:paginate

{favorites:paginate}
    Page {favorites:current_page} of {favorites:total_pages} pages
    {favorites:pagination_links}
{/favorites:paginate}

OR

{favorites:paginate}
    <ul class="pagination">
    {favorites:pagination_links}
        {first_page}
            <li><a href="{pagination_url}">First</a></li>
        {/first_page}
        {previous_page}
            <li><a href="{pagination_url}">&laquo; Previous</a></li>
        {/previous_page}
        {page}
            <li{if current_page} class="active"{/if}><a href="{pagination_url}">{pagination_page_number}</a></li>
        {/page}
        {next_page}
            <li><a href="{pagination_url}">Next &raquo;</a></li>
        {/next_page}
        {last_page}
            <li><a href="{pagination_url}">Last</a></li>
        {/last_page}
    {/favorites:pagination_links}
    </ul>
{/favorites:paginate}

Pagination is available for this tag and works just like regular EE pagination, but each variable/variable pair is prepended with favorites: (except for any variables and variable pairs inside of the favorites:pagination_links variable pair). Used in conjunction with the paginate parameter.

Conditionals

Most of the conditionals available in the Channel:Entries loop are available here. Additionally, these exist as well:

favorites:no_results

{if favorites:no_results}
    Sorry, there are no results.
{/if}

This conditional is shows its contents when there are no results, under the given parameters.

Examples

Below is a basic example of how you would display a given member’s entries saved to favorites:

<ul>
{exp:favorites:entries
    channel="articles"
    limit="25" paginate="bottom"
}
    <li>
        <a href="{url_title_path='articles/detail'}">{title}</a>
    </li>
    {favorites:paginate}
    <li>
        <ul class="pagination">
        {favorites:pagination_links}
        {first_page}
            <li><a href="{pagination_url}">First</a></li>
        {/first_page}
        {previous_page}
            <li><a href="{pagination_url}">&laquo; Previous</a></li>
        {/previous_page}
        {page}
            <li{if current_page} class="active"{/if}><a href="{pagination_url}">{pagination_page_number}</a></li>
        {/page}
        {next_page}
            <li><a href="{pagination_url}">Next &raquo;</a></li>
        {/next_page}
        {last_page}
            <li><a href="{pagination_url}">Last</a></li>
        {/last_page}
        {/favorites:pagination_links}
        </ul>
    </li>
    {/favorites:paginate}
{/exp:favorites:entries}
</ul>

Support

Having problems setting up and/or using Favorites? Support is offered from 10am to 4pm EST weekdays. Send us an email at help@eeharbor.com and we will respond as quickly as we can.